Frage

Ich schreibe eine Bibliothek (mit LIBTOOLS), in der alle API-Dokumentation mit Doxygen durchgeführt werden.

Ich frage mich, ob es eine einfache Möglichkeit gibt, die Installation der generierten Doxygen-Dokumentation in AUTOTOOLs integrieren zu können.

Ich finde, dass das Bauen der Dokumentation leicht genug sein sollte. Aber sobald ich doxygen lief, was ist der richtige Weg, um die generierten (z. B.) .html-Dateien in $ (htmldir) zu erhalten?

Das Problem scheint zu sein, dass ich nicht weiß (ich möchte auch nicht wissen), welche Dateien Doxygen für mich schaffen werden, also kann ich sie nicht wirklich in HTML_DATA Ich finde so etwas wie 'html_data= HTML /*.*' ist eine schlechte Idee

War es hilfreich?

Lösung

Während ich nicht viel Erfahrung mit AUTOTOOLS selbst habe, werden mehrere Vorschläge auf diesem E-Mail-Thread vorgenommen, die möglicherweise verwendet werden können: http://old.nabble.com/How-to-Install-Doxygen-generierte HTML-Dokumentation - TD17029178.HTML

Andere Tipps

Es könnte kompakter sein, um einige mitgeteilte Makros zu verwenden.Hier habe ich eine einfache Methode herauszufinden, basierend auf den Beispielen aus dem AUTOTOOLS-Buch von John Calcate PG 246.

Fügen Sie das folgende Fügen Sie den Konfigurieren ab.AC direkt über dem hinzu generasacodicetagpre.

linie generasacodicetagpre.

im verzeichnis projecTdir / docs

Fügen Sie zwei Dateien hinzu: doxyfile.in und makefile.am

Verwenden Sie beispielsweise Substitutionsgröße: generasacodicetagpre.

Nehmen Sie dann die ordnungsgemäße Änderung an anderen Doxygen-Konfigurationsfeldern vor. generasacodicetagpre.

Auf diese Weise generieren Sie die PDF-Datei.

das makefile.am sollte einfach sein: generasacodicetagpre.

(stellen Sie sicher, dass Sie den Makefile-Vertiefung einhalten, während Sie dies kopieren.)

Dies schien für mich gearbeitet zu haben.Die resultierende Dokumentation wird im Ordner docs erstellt.Bitte lass es mich wissen, wenn ich Fehler gemacht habe.

Ich benutze das Makro von Orten Ben-Kiki, siehe http://www.ben-kiki.org/oren/doxample/ oder Google es.Das Skript erstellt die Doxygen-Dokumentation im PDF / HTML / MAN (konfigurierbarer) Format.

Fügen Sie Ihre generierten Hilfedateien in der Liste * dist_doc_data * in makefile.am hinzu, um sie installieren zu lassen.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top