Doxygen と Markdown を使って技術マニュアルを書いています。HTML の生成を簡単にする Markdown と、Doxygen をコードに使用して長年の経験があり、機能を使用して適切なクロスドキュメントを作成する方法を知っているためです\ingroup
。
Doxygen の Markdown の処理では、後者を適切に動作させることができません。
私が達成したいのは、完全に説明的なトレーニング ドキュメントを作成することですが、重要なセクションにマークを付けて、後ですぐに参照できるように Doxygen にそれらを別の「ヒント」ページ (たとえば) に引き出すことができるようにすることです。
これらのスニペットは問題を示しています。すべてのファイルが.md
あり、正常に動作している別の mainpage.md があります。関連する MARKDOWN オプションは、doxyfile で YES に設定されています。グループは.h
/** */ を使用してファイルで定義されています。これは、.md ファイルで確実に動作することができなかったためです (これはおそらくこの問題に関連しています)。
「グループ 1」のテキスト ブロック
@ingroup group_01
# Group 01 MD heading
Text 1 for Group 1. Mirum est notare quam littera gothica.
グループ 2 のテキスト用に 1 つ
@ingroup group_02
# Group 02 MD Heading
Text 1 for group 2. Lorem banana dolor sit amet elit.
グループ1に必要な情報を含むファイルとグループ2の他の部分
@ingroup group_01
@{
# Text 2 group 1
Text 2 for group 1. Duis autem vel eum iriure dolor.
@}
@ingroup group_02
@{
# T2G2 THIS NEVER APPEARS
Text 2 for group 2. Nibble liber tempor cum soluta nobis.
@}
私が期待しているのは、「モジュール」セクションに 2 つのグループの 2 つのエントリが含まれており (実際にそうです)、グループ 1/2 ページに @ingroup でマークされたテキストが含まれていることです。
私が得たのは、最初に見 @ingroup
たものが期待どおりに処理されており、Doxygen がさまざまなグループ エントリを 1 つのページに正しく照合していることです。それ以外のテキストは出力にまったく表示されません。最後のファイルでテキスト ブロックの順序を入れ替えると、別のブロックが表示され、以前に表示されていたブロックが消えます。
@{ @}
ブレーシングを使用せず、単純に@ingroup_01
andを使用すると、同様の出力エラーが発生し@ingroup_02
ます。FWIW、@ingroup (group_01 group_02)
Markdownファイルでは機能しないようです。
私は何を間違っていますか?
私の目的を達成するための別の提案はありますか?
最新リリースの Doxygen 1.8.5 を使用しています。Doxygen のマニュアルには、これについて有益なことは何も書かれていません。
この質問はこれと似ていますが、コードの観点から問題を見ています。