Quickstart Doxygen: Unterschied zwischen den Versionen
Markierung: Manuelle Zurücksetzung |
|||
| Zeile 36: | Zeile 36: | ||
|- | |- | ||
| @retval || Funktion || Beschreibung möglicher Rückgabewerte | | @retval || Funktion || Beschreibung möglicher Rückgabewerte | ||
<syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /** | <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> | ||
/** | |||
@retval [Wert] [Beschreibung] | @retval [Wert] [Beschreibung] | ||
/* | /* | ||
Version vom 18. Oktober 2024, 10:02 Uhr
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
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.
| Tag | Target | Bedeutung |
|---|---|---|
| @brief | Funktion, Klasse, Modul | Kurzbeschreibung |
| @details | Funktion, Klasse, Modul | Ausführliche Beschreibung des Verhaltens |
| @param | Parameter | Beschreibung des Funktionsparameters |
| @return | Funktion | Beschreibung des Rückgabewerts |
| @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 |