Wie kann ich eine Datei erstellen, die nur "öffentliche" APIs in Doxygen dokumentiert

Question

Ich habe ein Projekt, an dem ich arbeite, das ist eine Bibliothek. Ich muss die Interna des Bibliothekscodes für meine eigenen Zwecke dokumentieren, muss aber auch ein API-Dokument an meine Benutzer weitergeben, wie sie die Bibliothek verwenden sollen.

Also, in dem Dokument, das ich ihnen geben wollen, möchte ich nur die „public“ Funktionen umfassen, Strukturen, Variablen, usw. - und nicht die interne diejenigen.

Gibt es eine Möglichkeit, das kann ich in Doxygen tun? Kann ich beschreiben, was "öffentlich" und was "privat" ist? Kann ich ein Dokument erstellen, das nur die "public" API für meine Benutzer enthält, und ein separates mit den "privaten" Designdetails für meine eigenen Zwecke?

HINWEIS: Dies ist gerade C, nicht C++ - und meine Verwendung der Begriffe "public" und "private" haben nichts mit "öffentlichen" und "privaten" Klassenmitgliedern zu tun.

Answer 1

Je nach Bedarf, gibt es mehr Möglichkeiten, dies zu tun:

• Sie können den \internal Tag
• verwenden können Sie den \private-Tag zusammen mit EXTRACT_PRIVATE=NO in doxyfile
• und wahrscheinlich noch andere beteiligt eine der verschiedenen EXTRACT_ Konfigurationsvariablen.