Doxygen: Nahtlose Dokumentation für Projekte mit C ++ und VHDL

8

Ich richte eine Dokumentation über eine Art von Bibliothek ein, die aus einem C / C ++ - und einem VHDL-Teil sowie aus einigen instruktiven Doxygen-Seiten besteht. Sie müssen in eine in sich geschlossene Gruppe zusammengefasst werden. Alles funktioniert so weit, schön und flauschig ...

Aber was, wenn ich die Ausgabe im vhdl-Unterverzeichnis mit OPTIMIZE_OUTPUT_VHDL = YES optimieren und die Ausgabe des c-Unterverzeichnisses mit OPTIMIZE_OUTPUT_C = YES gleichzeitig optimieren möchte?

Soweit ich verstehe, ist die Verwendung von doxygen-Tags in meinem Fall nicht optimal Es führt neue doxfile.conf-Dateien in jedem Unterverzeichnis ein, mit unabhängigen doxygen-Läufen in jedem Unterverzeichnis. Daher kann ich nicht mehr beide Teile (c + vhdl) in verschiedene Untergruppen derselben Gruppe einfügen, und Verbindungen zwischen den beiden Teilen sind nicht möglich. Außerdem sollte das gesamte Modul "in sich abgeschlossen" sein, um in größere Dokumentationen integriert werden zu können, ohne die spezielle Build-Struktur, die in diese Lösung involviert ist ...

Was würdest du tun?

    
marvin2k 24.02.2011, 09:35
quelle

1 Antwort

2

Ich hatte das gleiche Problem - schließlich haben wir Folgendes gemacht:

  1. Erstellen Sie ein anderes Verzeichnis für C-Code und VHDL-Code (+ entsprechende doxygen-Kommentardateien - da wir den Code nicht mit Doxygen-Tags überall spammen wollten).
  2. Führen Sie Doxygen für jedes dieser Verzeichnisse aus (jedes mit seinem eigenen oprimization-Tag - OPTIMIZE_OUTPUT_VHDL oder OPTIMIZE_OUTPUT_C )
  3. Kombiniere (manuell !!! - obwohl du ein Skript dafür erstellen kannst) die Ausgabe dieser beiden Verzeichnisse so, dass die Hauptseite auf die zwei Verzeichnisse verweist.

Irgendwann habe ich beschlossen, die Zeit zu verkürzen, die zum Generieren der Dokumentation benötigt wird, und ich ignoriere einfach die Optimierungs-Tags ...

    
Henry Aloni 17.04.2012 04:59
quelle

Tags und Links