Quickstart Doxygen

Aus HSHL Mechatronik
Zur Navigation springen Zur Suche springen

Einleitung

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

Was ist 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

Sollte in ihrem Projekt, schon eine Konfigurationsdatei angelegt worden sein können sie diese entweder direkt verwenden, oder falls sie Änderungen in der Konfiguration vornehmen wollen, laden Sie sie in den Doxywizzard und folgen sie der folgenden Anleitung.

Um Doxygen zu konfigurieren, müssen sie im Doxywizard auf den Reiter "Expert" umschalten.

Schritt 3: Konfigurationsdatei anpassen

Schritt 4: Kommentare in deinem Code hinzufügen

Schritt 5: Dokumentation generieren