Doxygen und Graphviz
Wer Code schreibt, schreibt irgendwann auch Dokumentation. Und wer Dokumentation schreibt, will sie nicht von Hand pflegen. Doxygen löst genau dieses Problem: Es liest den Quellcode – sowohl VHDL als auch C/C++ für den ESP32 – und erzeugt daraus automatisch eine sauber strukturierte HTML-Dokumentation. Kommentare im Code werden dabei direkt in lesbare Beschreibungen verwandelt.
Graphviz ergänzt Doxygen um die Fähigkeit, Abhängigkeiten und Aufrufgraphen als Diagramme darzustellen. Es ist kein eigenständiges Werkzeug im täglichen Einsatz, sondern eine stille Erweiterung – Doxygen ruft es im Hintergrund auf, wenn es Diagramme zeichnen soll.
Doxygen installieren
Die aktuelle Version von Doxygen findet man auf der offiziellen Projektseite unter:
https://www.doxygen.nl/download.html
Dort lädt man den Windows Installer herunter – erkennbar an der Dateiendung .exe. Nach dem Start des Installers folgt man den Schritten des Assistenten; die Standardeinstellungen sind für den Einsatz in diesem Kurs vollkommen ausreichend.
Doxygen bringt nach der Installation auch eine grafische Oberfläche mit – den Doxywizard. Er wird später beim Einrichten der Dokumentation nützlich sein.
Graphviz installieren
Graphviz wird auf der offiziellen Projektseite bereitgestellt:
https://graphviz.org/download/
Unter dem Abschnitt Windows wählt man den aktuellen Windows Installer für 64-Bit-Systeme und führt ihn aus. Während der Installation gibt es eine wichtige Option: „Add Graphviz to the system PATH" – diese unbedingt aktivieren. Nur so kann Doxygen das Programm dot später automatisch finden und aufrufen.
Nach der Installation lässt sich die korrekte Einrichtung kurz prüfen: Eine Eingabeaufforderung öffnen und dot -V eingeben. Erscheint eine Versionsnummer, ist Graphviz korrekt installiert und im PATH eingetragen.
Beide Tools sind installiert und bereit. Im nächsten Schritt geht es darum, ein Doxyfile einzurichten und die erste Dokumentation für den T-FPGA-Code zu erzeugen.