Come posso creare un file che documenta solo le API "pubbliche" in Doxygen

Question

Ho un progetto su cui sto lavorando e che è una libreria . Devo documentare le parti interne del codice della libreria per i miei scopi, ma devo anche consegnare un documento API ai miei utenti su come dovrebbero usare la libreria.

Così, nel documento desidero dare a loro, voglio includere solo le funzioni "pubbliche", le strutture, le variabili, ecc - e non i interne quelli.

C'è un modo per farlo in Doxygen? Posso delineare cosa è "pubblico" e cosa è "privato"? Posso generare un documento che contenga solo le API "pubbliche" per i miei utenti e uno separato con i dettagli di progettazione "privati" per uso personale?

NOTA: Questo è C corretto, non C++ - e il mio uso dei termini "pubblico" e "privato" non ha nulla a che fare con membri di classe "pubblici" e "privati".

Answer 1

A seconda del bisogno, ci sono diversi modi per farlo:

• è possibile utilizzare il \internal tag
• È possibile utilizzare il tag \private insieme EXTRACT_PRIVATE=NO in doxyfile
• e probabilmente altri che coinvolgono una delle varie variabili di configurazione EXTRACT_.