2013-09-07 11 views
5

Ich versuche, eine C-API zu dokumentieren, die alle in einer einzigen C-Header-Datei enthalten ist. Wenn ich Doxygen auf der Datei ausführen, gibt es mir Fehler für derzeit undokumentierte C-Makros, aber wenn ich die notwendige Dokumentation für Makros hinzufügen, obwohl die undokumentierten Fehler gelöscht werden, erscheinen die Makros plus Dokumentation nicht in der doxygen generierten HTML-Ausgabe.Dokumentation nicht in Doxygen Ausgabe

Nur ein Bruchteil der dokumentierten Header-Datei, die Strukturen, erscheint tatsächlich in einer beliebigen Doxygen-Ausgabe. Ich kann nichts in den Konfigurationseinstellungen oder in der Dokumentation sehen, die bei der Klärung helfen könnten, warum Doxygen keinen dokumentierten Code aus der Header-Datei in seine generierte Ausgabe legt.

Weiß jemand, warum das der Fall wäre?

Antwort

3

Siehe Artikel 2 und 3 des FAQ: http://www.doxygen.org/manual/faq.html

Kurzum Sie wahrscheinlich einen Kommentarblock mit @file fehlen Ihre Header-Datei zu dokumentieren.

+0

Der @file-Kommentar befindet sich in der Datei und keine der Lösungen in der FAQ macht einen Unterschied. Sie sind in einer klassenbasierten Weise geschrieben und sprechen über Namespaces, aber da ich eine direkte C-Kopfzeile bin, könnte das erklären, warum die FAQ-Lösungen mir nicht helfen. – jwhitmore

+2

@file sollte funktionieren, also poste bitte ein eigenständiges Beispiel (entweder hier oder in doxygens Bugtracker), damit ich das Problem selbst reproduzieren kann. – doxygen

+0

Hoppla! Die @Datei dokumentiert viel mehr, in der eigentlichen Dateidokumentation, aber was ich wirklich vermisse, sind die API-Funktionen. Leider sind im Header die API-Funktionen als C-Zeiger auf Funktionen deklariert. Ich dokumentiere sie mit einem "\ fn", aber diese tauchen überhaupt nicht auf. – jwhitmore

Verwandte Themen