Dokumentation mit Doxygen
-
Ich habe begonnen mit mit Doxygen meinen C-Code zu dokumentieren.
Ist im Moment nur ein File.
in dem Habe ich diverse Funktionen die Ich jeweils etwa so:/** * @name Name * @brief Parse command line options * @param argc The argument counter * @param argv The argument vector */
Komentiert habe.
Ebenso die Main, und auch die Structs.
Mal abgesehen davon, das meinem durch doxygen erstelltes HTML seeehr leer anfühlt,
liegt vl daran das es nur ein file ist, fehlt mir da der Quell Code.
Unter: Files->Globals->All main.c
finde ich Nur bei den Funktionen die angegeben sachen. sollte da nicht auch der Code stehen?
-
Wenn ich mich recht erinnere ist die Aufnahme des kompletten Quellcodes standardmäßig ausgeschaltet. Einfach mal das Doxyfile ein bisschen durchstöbern, dort ist schließlich alles gut dokumentiert. Das schadet auch allgemein nicht, da sind viele interessante Features zu finden. Die meisten will man zwar in der Regel auf der Standardeinstellung lassen, aber es ist schön zu wissen, dass es sie gibt, wenn man sie doch einmal braucht.
-
Der Tag INLINE_SOURCES muss auf YES stehen.
Zu finden im Doxywizard beim Reiter Expert -> Source Browser
Da kannst du auch gleich noch SOURCE_BROWSER anktivieren.SOURCE_BROWSER macht für jede Inputdatei eine eigene Datei mit Syntaxhighlight und Crossreferenz zu der eigentlichen Doku.
INLINE_SOURCES schreibt den Quellcode für jede Funktion mit in die Doku.