Quickstart Doxygen

Einleitung

Dieser Artikel soll eine Hilfe sein, beim erstellen oder aktualisieren von Dokumentationen von Quellcode mit Doxygen.

Anleitung

Schritt 1: Doxygen installieren

Als erstes sollten sie überprüfen, ob Doxygen schon installiert ist. Dafür können Sie zum Beispiel in der Windows-Suchleiste nach "Doxywizard" suchen. Sollten sie dieses Programm nicht haben, ist Doxygen nicht auf ihrem Gerät installiert.

Um Doxygen nun zu installieren, laden Sie sich hier die aktuelle Version herunter.

Schritt 2: Doxygen-Konfigurationsdatei erstellen

Um in Doxygen eine Konfigurationsdatei zu erstellen, müssen sie im Doxywizard auf den Reiter "Expert" umschalten.

Schritt 3: Konfigurationsdatei anpassen

Sollten Sie schon eine bestehende Konfigurationsdatei für ihr Doxygen Projekt haben, können Sie diese Anpassen in dem Sie sie über "File->Open" in Doxywizard laden und dann unter dem Reiter "Expert" anpassen.

Schritt 4: Kommentare in deinem Code hinzufügen

Kommentare in dem C-Code können einfach über das C-Projekt selber eingefügt werden. Es gibt allerdings Tags die Doxygen erkennt und diese anders verarbeitet.

Text der Überschrift

Tag	Target	Bedeutung	Beispiel
brief	Funktion, Klasse, Modul	Kurzbeschreibung	/** * @brief Berechnet die Summe von zwei Ganzzahlen /*
details	Funktion, Klasse, Modul	Ausführliche Beschreibung des Verhaltens	/** * @brief Berechnet die Summe von zwei Ganzzahlen * @details Diese Funktion nimmt zwei Integer als Eingabe und addiert diese zusammen und gibt ihre Summe zurück. /*
param	Parameter	Beschreibung des Funktionsparameters	/** * @param a Der erste zu addierende Integer. * @param b Der zweite zu addierende Integer. /*
return	Funktion	Beschreibung des Rückgabewerts	/** * @return Die Summe von a und b. /*
retval	Funktion	Beschreibung möglicher Rückgabewerte /** @retval [Wert] [Beschreibung] /*
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel
Beispiel	Beispiel