Doxygen als Externes Tool in Visual Studio Express anlegen

Um Doxygen als externes Tool in Visual Studio Express einzurichten, geht man folgendermaßen vor (ich benutze hier die englischsprachige IDE von Visual Studio Express verwendet):

  • Menü Tools -> External Tools…
  • Mit Hilde des Buttons „Add“ einen neuen Eintrag erstellen
  • Im Feld „Title“ den Namen „Doxygen“ eingeben
    • Dieser Name wird später im Menü angezeigt und dient dazu, das Tool zu identifizieren
  • Bei Command sucht man sich nun die Datei doxygen.exe aus der Installation von Doxygen heraus
  • Bei Arguments wird nun die Konfigurationsdatei für das Projekt angegeben.
    • Da diese Konfiguration global für alle Projekte gilt, habe ich mir einen kleinen Trick überlegt, mit dessen Hilfe man Doxygen für das gerade geöffnete Projekt aufrufen kann.
    • Dazu legt man zunächst eine Doxygen-Konfigurationsdatei für das Projekt an
    • Diese speichert man nun unter dem Namen der Solution-Datei im gleichen Ordner mit angehängten .doxygen
    • Nun kann man den Wert „$(SolutionDir)$(SolutionFileName).doxygen“ in „Arguments“ eintragen und die Dokumentation wird immer für das aktuell geöffnete Projekt erstellt
  • Es sollte noch der Haken bei „Use Output window“ gesetzt werden, damit man die Ausgabe von Doxygen im Output Fenster der IDE sehen kann.

 

Beispiel:
  • Das Projekt, welches dokumentiert werden soll heißt „FooBar“ und liegt unter C:\Projekte\Foobar
  • Die Solution-Datei des Projekts heißt „FooBar.sln“ und liegt unter  C:\Projekte\Foobar\FooBar.sln
  • Mit Hilfe von Doxywizard wird eine Konfigurationsdatei erstellt und in C:\Projekte\Foobar unter dem Namen „FooBar.sln.doxygen“ gespeichert
  • Nun kann nach obiger Einrichtung die Generierung über Tools -> Doxygen aufgerufen werden

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.