Doxygen
Auch für die Dokumentation von VHDL-Code eignet sich doxygen (ausgesprochen docs-y-gen) sehr gut. In diesem Tutorial wird die Installation vorgeführt und eine erste Dokumentation am Beispiel vom Projekt SimpleState erstellt.
Ich verwende immer noch die Version 1.7.4 von doxygen, da ich mit nachfolgenden Versionen nicht die gewünschte Formatierung bekomme und noch keine Zeit hatte, dieses Problem zu lösen.
Die aktuelle Version von doxygen (doxygen-1.8.13-setup.exe) findet man auf der Seite http://www.stack.nl/~dimitri/doxygen/download.html.
Ich verwende zur Installation allerdings die Version doxygen-1.7.4-setup.exe von der Seite https://sourceforge.net/projects/doxygen/files/rel-1.7.4/.
Installation von doxygen
Das Setup-Programm wird gestartet und die Installation mit den Default-Optionen durchgeführt.
Doxygen installieren Schritt 1 von 8
Doxygen installieren Schritt 2 von 8
Doxygen installieren Schritt 3 von 8
Doxygen installieren Schritt 4 von 8
Doxygen installieren Schritt 5 von 8
Doxygen installieren Schritt 6 von 8
Doxygen installieren Schritt 7 von 8
Doxygen installieren Schritt 8 von 8Installation von Graphviz
Graphviz enthält das dot Tool mit dem die Grafiken der Dokumentation erstellt werden.
Graphviz wird von der Seite http://www.graphviz.org/Download.php heruntergeladen. Unten auf dieser Seite muss man zuerst die Bedingungen akzeptieren, wählt danach "Stable and development Windows Install packages" und schließlich graphviz-2.38.zip.
Der Inhalt von graphviz-2.38.zip/release wird nun in ein neues Verzeichnis kopiert. Z.B. C:\Applic\Tools\Graphviz2.38.
Damit ist die Installation abgeschlossen.
Erstellen der VHDL-Dokumentation
Am Beispiel vom 2. Schritt des Projekts SimpleState soll nun die Erstellung einer automatischen Dokumentation gezeigt werden.
Als Vorbereitung wird das Repositories ausgepackt und auf den Zweig S3 gewechselt.
Doxygen wird über den Doxywizard gestartet und zuerst der Wizard Schritt für Schritt durchlaufen:
Doku generieren Schritt 1 von 6
Doku generieren Schritt 2 von 6
Doku generieren Schritt 3 von 6
Doku generieren Schritt 4 von 6
Doku generieren Schritt 5 von 6Am Ende des Wizards wird auf den Reiter Expert geklickt und der Pfad auf Graphviz sowie der Pfad auf die dot-Definitionsdateien eingegeben.
Die Definitionsdateien benötigt man für die Erstellung automatischer State Diagramme. Das Verzeichnis wird in das Editierfeld DOTFILE_DIRS eingegeben und mit dem Plus in das Listenfeld übernommen.
Nachdem nun alles definiert worden ist wird über den Reiter Run die Dokumentation erzeugt (Run doxygen) und das Ergebnis angezeigt (Show HTML Output).
Zum Abschluss werden die Definitionen über File/Save abgespeichert. Als Datei wird ./Sources/docu/doxyfile gewählt.
Doku generieren Schritt 6 von 6