Doxygen
Durch den Aufruf mit
doxygen Doxyfile
wird die Generierung der Dokumentation gestartet.
Was, wo und wie erstellt wird, ist in "Doxyfile" spezifiziert. In diesem Beispiel entsteht z.B. folgende HTML-Seite. Das Latex Dokument muß allerdings noch mit "make" erstellt werden, die notwendige Makedatei wird allerdings generiert.

Die Konfiguration in der Datei Doxyfile unterteilt sich in einen allgemeinen Teil für Projektname, Versionsnummer, Projektverzeichnis, Dateien, Ebenen der Dokumentation, usw. und einen Teil speziell für das entsprechende Ausgabeformat.

Zu beachten ist:
  • Jedes Projekt benötigt seine eigene Konfigurationsdatei
  • Für die Konfigurationsdatei sollte man eine Vorlage anlegen:
    • einheitliche CSS-Seitengenerierung (HTML)
    • einheitliche Sprache
      (Englisch ist zu bevorzugen, da einige Einträge nur unzureichend oder gar nicht übersetzt)
    • einheitliche Struktur/Tiefe der Dokumentation
  • Einbindung der mathematischen Formeln bei komplexen Algorithmen
Erstellen von Vorlagen für die entsprechenden Ausgabeformate erfolgt duch
doxygen -w <typ> <optionen>
Dabei kann <typ> "rtf", "html" oder "latex" sein. Die Optionen hängen von Typ und (außer bei rtf) optional von der Konfigurationsdatei ab.