2012-10-26 43 views
18

コメントの中にマークダウンを使用することができ、doxygenがそれを理解できることがわかっています。しかし、マークダウン形式でドキュメンテーションを生成することが可能かどうかを知る必要がありますか?doxygenを使ってマークダウンファイルとして文書を生成する

これらのドキュメントは、C++ファイルから生成する必要があります。

+1

私はあなたがおそらくあなた自身の値下げ変換モジュールを書くことができ、生のXML出力を使用して推測します。しかし、(たとえ100%でなくても)ダイレクトマークダウンの出力が不可能であることは確かです。 –

答えて

5

私はこの質問は古いですが、利用可能な新しいツールがあるように思われる知っている:https://www.npmjs.com/package/doxygen2md

+0

ありがとうございます。これは私が持っていた問題を解決する良い方法のように見えます。 – Sudar

5

私はそれを直接行うことはできませんが、DoxygenはXML document using the XML generatorを出力することができます。

XMLデータを変換するためにXMLデータを使用することができるさまざまなプロジェクトがあります。Breatheは、Sphinxがドキュメントを出力するために使用できるものにXMLドキュメントを変換するために使用されています。 Doxygenをプリプロセッサとして使って言うことができます。

Breatheのコードは、Sphinxが必要とするReStructuredTextファイルではなく、Markdownファイルを生成するための出発点として使用するのに十分単純です。私はBreatheのコードを見ていないが、いくつかの主要なプロジェクトに使用している。

+0

Breatheは、Sphinxファイルが解析されると同時に、Sphinx/docutilsツリー構造にコンテンツを挿入します。中間のReStructuredTextファイルは、プロセス内で決して作成されません。 –

関連する問題