Arbeiten mit Doxygen

Beschreibung
Dieses Tool ist für zwei Zwecke sehr gut einzusetzen: Zum Einen zur Dokumentation von Software, zum Anderen für die eingehende Analyse einer fremden Software. Dabei ist das Visualisierungstool Graphviz sehr hilfreich, da ich damit auch den ‚Call Graph‘ und den ‚Called by Graph‘ sehen kann, also welche Funktion von wem aufgerufen wird. Damit bekomme ich meist einen guten Überblick über die Struktur einer Software. Bei einer Multitasking  Software schafft Doxygen das nur für die einzelnen Tasks,  da es Multitasking nicht kennt.

Herunterladen
Für die Arbeit mit Doxygen wird ein Visualisierungstool benötigt: Graphviz
Und natürlich Doxygen selbst.

Installieren
Die Installation sollte problemlos funktionieren. Die Reihenfolge ist dabei wichtig: erst Graphviz, dann Doxygen.

Konfiguration
Für den Einsatz von Doxygen im konkreten Projekt muss es mit dem Doxywizard erst konfiguriert werden:

Step1

Hier wird der Pfad zu doxygen.exe eingetragen. Nach der Standard Installation  also C:\Program Files\doxygen\bin

Step2

Reiter Wizard

  • Topic Project:
    Eintragen der Projektdaten ( Name und Version ), sowie der Pfad zu den Sourcen. Recursive nur, wenn es auch Unterverzeichnisse gibt. Für die Ausgabedaten empfiehlt sich ein eigener Unterordner, z.B. Doxy-Doku.
  • Topic Mode:
    Als Extraction Mode wähle ich für meine Sourcen ‚All Entities‘ und inkludiere die Sourcen. Da mein Projekt in C programmiert ist, wähle ich C als Programming Language.
  • Topic Output:
    Ich lasse HTML stehen, so wie es ist, mitsamt search-function. Latex klicke ich weg.
  • Topic Diagrams: Hier wähle ich ‚dot tool from the graphviz package‘. Unter ‚dot graphs to generate‘ aktiviere ich alle Häkchen.

Reiter Expert

  • Topic Project:
    Als Ausgabesprache wähle ich ‚German‘.
  • Topic Source Browser:
    Ich aktiviere ‚Inline Sources‘
  • Topic Dot:
    Hier aktiviere ich den ‚UML look‘ und trage unter ‚Dot path‘ den Pfad zum dot tool (graphviz) ein. In meinem Fall ist das C:\Program Files (x86)\Graphviz2.38\bin

Alle anderen Topics lasse ich so wie sie sind.

Reiter Run

Mit ‚Run Doxygen‘ starte ich dann das Tool.
Mit ‚Show HTML Output‘ kann ich mir das Ergebnis im Browser bequem und übersichtlich anschauen.

Beim Beenden wird noch gefragt, wo die geänderten Einstellungen gespeichert werden sollen. Ich lege sie in mein Arbeitsverzeichnis parallel zum Ordner Doxy-Doku an.

Links

Graphviz
http://www.graphviz.org

Doxygen
http://www.doxygen.org

Veröffentlicht von

Jürgen

Ich bin Software Ingenieur und habe meine Schwerpunkte in allen Aktivitäten, die zur Software Entwicklung gehören. Am längsten bin ich als Software Entwickler von Embedded Software in C tätig.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.