Ich weiß, dass es möglich ist, Markdown in Kommentaren zu verwenden und doxygen kann es verstehen. Aber ich muss wissen, ob es möglich ist, die Dokumentation im Abschriftenformat zu generieren?Generieren Sie Dokumentation als Markdown-Dateien mit doxygen
Ich brauche diese Dokumentation aus C++ - Dateien generiert werden.
Ich weiß, diese Frage ist alt, aber es scheint ein neues Werkzeug zur Verfügung steht: https://www.npmjs.com/package/doxygen2md
Danke. Das sieht nach einer guten Möglichkeit aus, das Problem, das ich hatte, zu lösen. – Sudar
Ich weiß nichts von dem, was es direkt tun wird, aber Doxygen hat die Fähigkeit, eine XML document using the XML generator auszugeben.
Es gibt verschiedene Projekte gibt, die dann die consume können XML-Daten, die es zu transformieren, ist eine der einfachsten, die ich von ist Breathe bewusst bin, der verwendet wird, um die XML-Dokumente, um etwas zu konvertieren, die Sphinx zur Ausgabe Dokumentation verwenden können mit Doxygen als Pre-Prozessor sozusagen.
Der Code für Breathe kann einfach genug sein, um als Ausgangspunkt zu verwenden, um dann Markdown-Dateien anstelle der ReStructuredText-Dateien zu generieren, die Sphinx benötigt. Ich habe mir den Code für Breathe nicht angesehen, aber ich habe ihn für einige große Projekte verwendet.
Breathe fügt Inhalt direkt in die Sphinx/Docutils-Baumstruktur ein, während die Sphinx-Dateien analysiert werden. ReStructuredText-Zwischendateien werden niemals in diesem Prozess erstellt. –
XML mit Doxygen generieren http://www.stack.nl/~dimitri/doxygen/customize.html#xmlgenerator.
Mit PanDoc http://pandoc.org/ XML in Markdown konvertieren.
Dies ist eine falsche Antwort, "XML" ist ein sehr generisches Format und Pandoc hat keine Unterstützung für doxygens XML-Ausgabe. –
ich die rohe XML-Ausgabe erraten verwendet Sie wahrscheinlich Ihren eigenen Abschlag Umwandlungsmodul schreiben können. Aber ich bin mir ziemlich sicher (auch wenn nicht 100%) direkte Markdown-Ausgabe ist noch nicht möglich. –