Doxygen:Konfiguration
Aus KissDoc
Inhaltsverzeichnis |
Thema: Doxygen
Installation
Für die Übersetzung des Sourcecodes benötigt man noch die Packages bison und flex. Danach hilft
./configure make
Ein make install (Anleitung) wird nicht benötigt, wenn das Package als *.deb eingepflegt werden soll. Eigentlich sind nur folgende Dateien interessant:
bin/doxygen bin/doxytag sed -ie "s/VERSION/1.5.6/g" -e "s/DATE/$(date +'%B %Y')/g" doc/doxygen.1 sed -ie "s/VERSION/1.5.6/g" -e "s/DATE/$(date +'%B %Y')/g" doc/doxytag.1
Bison und flex kann nach der Installation wieder entfernt werden.
Update
Neuere Doxygen Versionen benötigen teilweise ein update der Konfigurationsdatei:
doxygen -u
Konfiguration
Damit doxygen korrekt funktioniert muss fuer das Project eine Konfigurationsdatei erstellt werden. Ein doxygen -g Doxyfile erledigt das fuer uns. Innerhalb der Konfigurationsdatei kann festgelegt werden, wie die generierte Doku aussieht und welche files ueberhaupt fuer die Dokumentation herangezogen werden.
Ein paar wichtige Optionen:
JAVADOC_AUTOBRIEF = YES # damit reagiert doxygen mehr wie javadoc, dh. das @brief tag ist nicht unbedingt erforderlich HIDE_UNDOC_MEMBERS = YES # verstecken der nichtdokumentierten Member und Attribute GENERATE_TODOLIST = YES # erstellt fuer jede klasse die ein @todo tag hat eine seperate todo liste in der doku OUTPUT_DIRECTORY = ./doc/ # legt ein vernünftiges Zielverzeichnis fest GENERATE_LATEX = NO # wird derzeit nicht verarbeitet GENERATE_MAN = YES # damit die Docu für dern vi passt
Ein doxygen <configfile> generiert jetzt die Doku.
