Dokumentieren mit Doxygen: Tools & Beispiele

Alle Beispieldateien aus dem Kapitel Dokumentieren mit Doxygen stehen auch als Zip-Datei bsp-doxygen.zip oder als Archivdatei bsp-doxygen.tar.gz zur Verfügung.

Codebeispiele aus dem Buch

Seite 26

Einführendes Beispiel: example01.cpp , Doxyfile

Seite 34

Dokumentation von Klassen, Strukturen, Varianten, Aufzählungen: class_demo.h , Doxyfile

Seite 40

Dokumentation von Funktionen: func_docu.h , Doxyfile

Seite 43

Dokumentation von Funktionszeigern: var_docu.h , typedef_docu.h , Doxyfile

Seite 48

Links mit Doxygen: print.h , types.h , Doxyfile

Seite 52

Abkürzungen und Wiederholungen: person.h , Doxyfile

Seite 58

Graphen mit dot: main.dox , Doxyfile

Seite 59

Graphen mit mscgen: transceiver.cpp , Doxyfile

Seite 69

Module: module_demo.c , Doxyfile

Seite 72

Gruppen: member_demo.h , Doxyfile

Seite 75

Zeichen- und Absatzformatierung: format_demo.h , Doxyfile

Seite 80

Spezielle Absätze: print2.h , Doxyfile

Seite 85

Hauptseite: mainpage.dox , Doxyfile

Doxygen-Filter zur Extraktion der Revisionsnummer aus Subversion

Seite 89

In der Doxygen-Konfigurationsdatei kann unter der Einstellung FILE_VERSION_FILTER ein Versionsfilter zur Ableitung der Version einer Quelldatei angegeben werden.

Wenn Sie Ihre Quelltexte mit Subversion verwalten und Windows als Betriebssystem verwenden, dann kann das JScript svn_revision_number.js als Versionsfilter verwendet werden.

In die Doxygen-Konfigurationsdatei wird das Filter mit dem Eintrag

FILE_VERSION_FILTER = cscript.exe /Nologo svn_revision_number.js

eingebunden.