Inhaltsverzeichnis

Doxygen

Doxygen

Doxygen

Doxygen ist ein freies Software-Dokumentationswerkzeug für unterschiedliche Programmiersprachen. Dazu wird der Quellcode mit speziellen Kommentaren angereichert, aus welchen Doxygen dann eine übersichtliche Dokumentation erstellt. Als Ausgabeformat unterstützt Doxygen folgende Dateitypen:

Unterstützte Programmiersprachen

Vollständig Eingeschränkt Über zusätzliche Filter
C PHP Perl
C++ C# Object Pascal
Objective-C D
Java VHDL
Phython Tcl
Fortran
IDL

Einfaches Beispiel

/**
 * \brief  Beispiel Funktion
 *
 *         Diese Funktion gibt den übergebenen Parameter
 *         auf der Konsole aus.
 *
 * \param      x   Auszugebender Parameter
 * \return         Status-Code
 *
 */
int foo(int x) {
    printf("Parameter: %d", x);
    return 0;
}

Beispiele aus der Praxis können im EEROS Robotics Framework nachgeschlagen werden. Beispielsweise die Klasse Gain besitzt eine gute Dokumentaion mit Doxygen.