c - doxygenがCファイルに#definesを文書化しないようにするにはどうすればよいですか？

Question

#defineヘッダーには確かにDoxygenに文書化させたい値がありますが、静的定数として扱うCファイルには他の値があり、Doxygenに文書化させたくありません。シンプルで愚かなもの

#define NUMBER_OF(a) (sizeof((a))/sizeof((a)[0]))
#define MSTR(e) #e

#defineDoxygenが作成するドキュメントにそれらを入れないようにするにはどうすればよいですか？でマークを付けてみました@internalが、役に立たなかったようです。

Doxygenと#define、どうすれば入手できますか？

#define SOME_CONSTANT 1234 /**< An explanation */

「SOME_CONSTANT」と「Andescription」を出力に入れますが、「1234」は入れませんか？

score 12 · Accepted Answer

\condand\endcondコマンドを使用する必要はありません。\hideinitializer次のコマンドを使用するだけで、初期化子を非表示にできます。

#define SOME_CONSTANT 1234 /**< An explanation @hideinitializer */

最初の質問に関しては、設定することができHIDE_UNDOC_MEMBERS = YES、Doxygenドキュメントブロックを持つマクロのみが出力に表示されます。

score 5 · Accepted Answer

doxyfile で MAX_INITIALIZER_LINES = 0 を設定して、定義の値を非表示にすることができます。

score 3 · Accepted Answer

タグを使用したDoxygen解析からコードの任意の部分を除外でき\cond ... \endcondます。

編集：いくつかの関連する質問：

score 1 · Accepted Answer

それでもうるさくて不自然に見えることは間違いありませんが、他の質問に対処するには、次のことを試してください。

/** An explanation */
#define SOME_CONSTANT /** @cond */ 1234 /** @endcond */

score 0 · Accepted Answer

ドキュメントを .c ファイルから .h ファイルに移動することで、この問題を解決しました。次に、.h ファイルに対してのみ doxygen を実行します。

次に、文書化したい項目 (「パブリック」項目) は、本質的に doxygen が取得するものです。

以前は「パブリック」アイテムを .h ファイルに、「プライベート」アイテムを .c ファイルに入れるように注意してきたので、これは非常にうまく機能します。

この手法は、doxygen がインクルードを取り込んでいることに気付いたときに思い浮かびました。呼び出し元のモジュールが自分のモジュールを使用するために必要なインクルードのサブセットも移動すると、そのリストも文書化されることに気づきました。

この手法には、さらに利点があります。ドキュメントを更新する際に、ドキュメントをあるターミナルウィンドウに表示し、ソースを別のターミナルウィンドウに表示することができます。

7 に答える 7