Seitenleiste
Inhaltsverzeichnis
Doxygen
Doxygen geniert Dokumentation aus Quelltexten verschiedener Sprachen. Hierfür werden verschiedene Tags innerhalb der Kommentare des Quelltextes verwendet.
Cheat-Sheet
| <sharp> | Argument ist 1 Wort |
| (round) | Argument geht bis zum Zeilenende |
| {curly} | Argument stellt einen Absatz dar |
| [square] | Argument ist optional und kann weggelassen werden |
Kommentare setzen
| Tag | Bedeutung |
|---|---|
| / | Beginnt eine einzeilige Dokumentation für den nachfolgenden Text | | /< | Beginnt eine einzeilige Dokumentation für den vorhergehenden Text |
| / */ | Umschließt eine mehrzeilige Dokumention für den nachfolgenden Text | | /< */ | Umschließt eine mehrzeilige Dokumentation für den vorhergehenden Text |
Tags
| Tag | Bedeutung |
|---|---|
| @file [<name>] … | Dateiname und Beschreibung |
| @brief {description} | Kurzbeschreibung |
| @param <name> {description} | Parametername mit anschließender Beschreibung |
| @return {description} | Beschreibung des Rückgabewertes |
| @retval <value> {description} | Bedeutung eines Rückgabewertes |
| @pre {description} | Beschreibung von Vorabbedingungen für diese Funktion/Methode |
| @post {description} | Beschreibung von Nachbedingungen für diese Funktion/Methode |
Formatierung
| Tag | Bedeutung |
|---|---|
| @note {description} | Notiz/Bemerkung |
| @warning {description} | Warnung |
| @par <title> {description} | Absatz |
| @todo {description} | Anmerkung, die auf einer separaten Todo-Liste gesammelt wird |
| @b <word> | Das nachfolgende Wort wird fett geschrieben |
| @c <word> | Das nachfolgende Wort wird mit der Schriftart 'Courier' geschrieben (Festbreite) |
| @e <word> | Das nachfolgende Wort wird kursiv geschrieben |
| @code | Der nachfolgende Bereich wird bis @endnote mit der Schriftart 'Courier' ausgegeben. Es handelt sich um Quelltext |
| @endcode | Beendet @code-Abschnitt |
| @verbatim | Der nachfolgende Bereich wird bis @endverbatim mit der Schriftart 'Courier' ausgegeben. Es handelt sich nicht um Quelltext |
| @endverbatim |
Sonderzeichen
| \n | Insert a new line (force a line break) |
| - (item) | Liste mit Punkt vor dem Eintrag |
| -# (item) | Numerierte Liste |
| @image html „image.jpg“ | fügt ein Bild aus einem vorkonfigurierten Verzeichnis in die html-Dokumentation ein |
| http://www.url.com/ | URLs werden in HTML automatisch hervorgehoben |
Hinweis
Statt @ vor den Anweisungen kann auch '\' verwendet werden, z.B. \param statt @param.