Hinweis: Diese Inhalte wurden mit Unterstützung von Künstlicher Intelligenz erstellt und redaktionell überprüft (Transparenzhinweis gemäß Art. 50 EU AI Act).
Doxygen
Hinweis: Diese Inhalte wurden mit Unterstützung von Künstlicher Intelligenz erstellt und redaktionell überprüft (Transparenzhinweis gemäß Art. 50 EU AI Act).
Doxygen erzeugt aus Kommentaren im Quellcode eine Dokumentation als Website. Es liest die Beschreibungen von Funktionen, Parametern und Rückgabewerten direkt aus den Quelldateien und zeichnet auf Wunsch Diagramme, welche Funktion welche aufruft. Es eignet sich vor allem für C und C++, versteht aber auch Java, Python, C#, PHP und weitere Sprachen.
Vorbemerkungen
- Pakete aus Ubuntu: Doxygen und Graphviz sind in den Ubuntu-Paketquellen enthalten und werden mit
aptinstalliert. Graphviz liefert das Programmdot, mit dem Doxygen die Diagramme zeichnet. - Kein Compiler nötig: Doxygen liest den Quellcode nur, es übersetzt ihn nicht. Das Beispiel ist in C geschrieben. Wie man C-Programme übersetzt, steht in der Anleitung C.
- Version: Getestet mit Doxygen 1.15.0 und Graphviz 14.1.2 aus Ubuntu 26.04.
Installation
1. Paketlisten aktualisieren
Damit apt die aktuellen Versionen kennt.
sudo apt update
2. Doxygen und Graphviz installieren
sudo apt install doxygen graphviz
Prüfen: Der erste Befehl zeigt 1.15.0, der zweite dot - graphviz version 14.1.2 (oder jeweils eine neuere Nummer).
doxygen --version
dot -V
Ein Projekt dokumentieren
3. Projektordner anlegen
-p legt den Ordner ~/meinrechner und darin den Unterordner src für den Quellcode in einem Schritt an.
mkdir -p ~/meinrechner/src
4. In den Projektordner wechseln
Alle weiteren Befehle werden hier ausgeführt.
cd ~/meinrechner
5. Header-Datei mit Kommentaren anlegen
In der Header-Datei stehen die Funktionen, die das Programm anbietet, zusammen mit ihrer Beschreibung.
nano src/rechner.h
Füge diesen Inhalt ein (Strg+Umschalt+V):
/**
* @file rechner.h
* @brief Einfache Rechenfunktionen.
*/
#ifndef RECHNER_H
#define RECHNER_H
/**
* @brief Addiert zwei ganze Zahlen.
*
* @param a Erster Summand.
* @param b Zweiter Summand.
* @return Die Summe von @p a und @p b.
*/
int addiere(int a, int b);
/**
* @brief Berechnet das Quadrat einer Zahl.
*
* @param x Die Zahl.
* @return @p x mal @p x.
*/
int quadrat(int x);
/**
* @brief Berechnet a² + b².
*
* Nutzt dafür quadrat() und addiere().
*
* @param a Erste Zahl.
* @param b Zweite Zahl.
* @return Die Summe der Quadrate.
*/
int summe_der_quadrate(int a, int b);
#endif
So liest Doxygen die Kommentare:
- Nur Kommentare, die mit
/**beginnen, gehören zur Dokumentation. Normale Kommentare mit/*oder//übergeht Doxygen. @filemeldet die Datei bei Doxygen an. Ohne diese Zeile erscheinen Funktionen, die nur in einer Datei stehen, nicht in der Dokumentation.@briefist die Kurzbeschreibung für Übersichten. Der Text nach der Leerzeile ist die ausführliche Beschreibung.@parambeschreibt einen Parameter,@returnden Rückgabewert,@phebt einen Parameternamen im Text hervor.- Schreibt man im Text einen Funktionsnamen mit
(), z. B.quadrat(), setzt Doxygen einen Link auf deren Beschreibung.
Speichere mit Strg+O und Enter und beende nano mit Strg+X.
6. Quelldatei anlegen
Hier stehen die eigentlichen Funktionen. Die Beschreibungen stehen schon in der Header-Datei und werden nicht wiederholt. Nur der @file-Kommentar ist nötig. Ohne ihn fehlt der Aufrufgraph in Schritt 9.
nano src/rechner.c
Füge diesen Inhalt ein:
/**
* @file rechner.c
* @brief Umsetzung der Rechenfunktionen.
*/
#include "rechner.h"
int addiere(int a, int b)
{
return a + b;
}
int quadrat(int x)
{
return x * x;
}
int summe_der_quadrate(int a, int b)
{
return addiere(quadrat(a), quadrat(b));
}
Speichere mit Strg+O und Enter und beende nano mit Strg+X.
7. Konfigurationsdatei anlegen
Doxygen liest seine Einstellungen aus der Datei Doxyfile. Der Befehl doxygen -g würde eine Vorlage mit über 3000 Zeilen erzeugen. Das ist nicht nötig: Es reicht, nur die Einstellungen einzutragen, die vom Standard abweichen.
nano Doxyfile
Füge diesen Inhalt ein:
PROJECT_NAME = "Mein Rechner"
OUTPUT_LANGUAGE = German
INPUT = src
RECURSIVE = YES
OUTPUT_DIRECTORY = doku
OPTIMIZE_OUTPUT_FOR_C = YES
GENERATE_LATEX = NO
HAVE_DOT = YES
CALL_GRAPH = YES
PROJECT_NAME– steht oben auf jeder Seite.OUTPUT_LANGUAGE = German– Überschriften wie „Funktionen“, „Parameter“ und „Rückgabe“ erscheinen auf Deutsch.INPUTundRECURSIVE– Doxygen liest den Ordnersrcsamt Unterordnern.OUTPUT_DIRECTORY– die fertige Dokumentation landet im Ordnerdoku.OPTIMIZE_OUTPUT_FOR_C– Beschriftungen passend für C statt für C++ (z. B. keine „Klassen“).GENERATE_LATEX = NO– nur HTML erzeugen, keine LaTeX-Dateien für ein PDF.HAVE_DOTundCALL_GRAPH– mit Graphviz Diagramme zeichnen, auch dazu, welche Funktion welche aufruft.
Speichere mit Strg+O und Enter und beende nano mit Strg+X.
8. Dokumentation erzeugen
Ohne weitere Angabe liest doxygen die Datei Doxyfile im aktuellen Ordner.
doxygen
Prüfen: Die Ausgabe endet mit finished.... Zeilen mit warning: weisen auf Fehler in den Kommentaren hin, z. B. einen falsch geschriebenen Parameternamen, und nennen Datei und Zeile. Die Zeile Warn for undocumented namespaces... ist keine Warnung, sondern nur eine Fortschrittsmeldung.
9. Dokumentation ansehen
Öffnet die Startseite im Standardbrowser.
xdg-open doku/html/index.html
Prüfen: Oben steht „Mein Rechner“ mit dem Suchfeld „Suchen“. Klicke links auf „Dateien“ und dann auf rechner.h. Die Seite „rechner.h-Dateireferenz“ listet unter „Funktionen“ die drei Funktionen mit ihren Kurzbeschreibungen. Weiter unten stehen bei jeder Funktion „Parameter“ und „Rückgabe“. Bei summe_der_quadrate() zeigt ein Diagramm die Aufrufe von addiere und quadrat.
Nach jeder Änderung an den Kommentaren führst du Schritt 8 erneut aus und lädst die Seite im Browser neu (F5).
Der Ordner doku/html ist eine fertige statische Website. Jeder Webserver kann ihn ausliefern, zum Beispiel wie in Statische Website mit nginx beschrieben.
Aktualisieren
Doxygen und Graphviz kommen aus den Ubuntu-Paketquellen und werden mit den normalen Systemupdates aktualisiert.
sudo apt update && sudo apt upgrade
Deinstallieren
1. Doxygen und Graphviz entfernen
purge entfernt die Programme samt ihrer Systemdateien. Wer Graphviz für andere Programme weiter braucht, lässt graphviz im Befehl weg.
sudo apt purge doxygen graphviz
2. Nicht mehr benötigte Pakete entfernen
Entfernt die Bibliotheken, die mit Doxygen und Graphviz installiert wurden, sofern kein anderes Programm sie braucht. Lies vor dem Bestätigen die Liste.
sudo apt autoremove --purge
Prüfen: Die Ausgabe enthält Kommando nicht gefunden.
doxygen --version
3. Projektordner löschen (optional)
Achtung: Damit sind auch der Quellcode und die erzeugte Dokumentation gelöscht.
rm -r ~/meinrechner
Quellen und Lizenz
- Offizielle Dokumentation: https://www.doxygen.nl/manual/index.html
- Lizenz: Doxygen steht unter der GPL-2.0.
Hinweis: Diese Inhalte wurden mit Unterstützung von Künstlicher Intelligenz erstellt und redaktionell überprüft (Transparenzhinweis gemäß Art. 50 EU AI Act).
Open Knowledge (Freies Wissen): Alle Texte stehen unter der freien Lizenz Creative Commons Namensnennung – Weitergabe unter gleichen Bedingungen 4.0 International (CC BY-SA 4.0) und können frei gelesen, geteilt und weiterverarbeitet werden.