doxygen - nur public interface dokumentieren



  • Kann ich in doxygen einstellen, dass nur öffentliche Methoden und Attribute in der Dokumentation auftauchen?
    Und werden beim miterstellen eines Source-Verzeichnisses ebenfalls doxygen-kommentare geparst (konnte ich nicht testen, da ich noch keinerlei doxygen kommentare drin hab)?

    Wenn ich so ein konstrukt habe:

    #if defined( UNICODE )
    # define GenText(str) L##str
    #else
    # define GenText(str) str
    #endif
    

    Dann zeigt es mir in der doku nur letzteres makro an und nicht beide. Kann man einstellen, dass alle Makros und Defines auftauchen unabhängig von den #if/#else Konstrukten?

    Da ich boost::serialization verwende, muss ich in meinem Projekt teilweise in den boost::serialization namespace schreiben, der taucht deswegen auch in der doku auf, kann ich das irgendwie unterbinden?



  • In der doxygen-Konfigurationsdatei kannst du einstellen, dass er nur öffentliche Methoden darstellen soll.

    Wenn etwas von Doxygen nicht berücksichtigt werden soll, kannst du es mit einem ifndef-ausblenden. Steht aber alles in der Doxygen Dokumentation.


Anmelden zum Antworten