Generieren von Dokumentation als markdown-Dateien mit doxygen

Ich weiß, dass es möglich ist, mit markdown-innen Kommentare und doxygen kann es verstehen. Aber ich muss wissen, ob es möglich ist, zum generieren der Dokumentation im markdown-format?

Ich brauche diese Dokumentation aus C++ - Dateien.

  • Ich denke, mit den rohen XML-Ausgabe kann man wahrscheinlich schreiben Sie Ihre eigenen markdown-Konvertierung Modul. Aber ich bin mir ziemlich sicher (auch wenn nicht 100%) direkte markdown-Ausgang ist nicht möglich, noch nicht.
InformationsquelleAutor Sudar | 2012-10-26
  1. 6

    Ich weiß, diese Frage ist alt, aber es scheint zu sein, ein neues tool zur Verfügung: https://www.npmjs.com/package/doxygen2md

    • Danke. Das sieht aus wie ein guter Weg, um das Problem zu lösen, dass ich hatte.
    • moxygen ist sehr ähnlich zu diese als gut.
    InformationsquelleAutor bonanza
  2. 5

    Ich weiß nicht, was es zu tun direkt, aber doxygen hat die Möglichkeit zur Ausgabe in eine XML-Dokument mithilfe des XML-generator.

    Gibt es verschiedene Projekte gibt, die können dann konsumieren, sagte die XML-Daten zu transformieren, eine der einfachsten, dass ich mir bewusst bin, ist Atmen, die zum konvertieren der XML-Dokumente etwas, die Sphinx verwenden können, um die Ausgabe der Dokumentation mit doxygen als pre-Prozessor so zu sagen.

    Den code für Atmen kann einfach genug sein, um als Ausgangspunkt, um dann zu erzeugen, Markdown-Dateien statt den ReStructuredText-Dateien, die Sphinx erfordert. Ich habe nicht geschaut auf den code, der für das Atmen, aber ich habe es verwendet für einige wichtige Projekte.

    • Atmen Sie fügt Inhalte direkt in die Sphinx/docutils Baumstruktur, wie Sie die Sphinx-Dateien analysiert werden. Intermediate ReStructuredText-Dateien nie erstellt in den Prozess.
    InformationsquelleAutor X-Istence
  3. 4

    Generieren von XML mit doxygen http://www.doxygen.nl/manual/customize.html#xmlgenerator.

    Verwenden PanDoc http://pandoc.org/
    die Konvertierung von XML zu Markdown.

    • Dies ist eine falsche Antwort, "XML", ist ein sehr generisches format und pandoc hat keine Unterstützung für doxygen ist die XML-Ausgabe.
    InformationsquelleAutor mkuse
Schreibe einen Kommentar