doxygenを使用してCコードを文書化しようとしています。 #defineでマクロとして設定されたいくつかのデフォルト値があります。Cのdoxygenドキュメント内で非関数マクロを展開する
例えば:私は私が望むようにデフォルト値を扱うエイリアスを追加していました。doxygen内部
#define DEFAULT_WIDTH 100
#define DEFAULT_HEIGHT 200
(私はCにデフォルト値を持っていない知っているが、これは単なる一例です)。以下の関数例を考えてみましょう
//! Initializes something
//! @param width The width @default DEFAULT_WIDTH
//! @param height The height @default DEFAULT_HEIGHT
//! @return Result of initialization
char initSomething(int width,int height);
これは、私が1つの重要な事実を除いて望むようにドキュメントを生成します。 DEFAULT_WIDTHとDEFAULT_HEIGHTは展開されません。マクロ名は取得できますが、それぞれ100と200ではありません。私はMACRO_EXPANSIONとENABLE_PREPROCESSINGをチェックしています。
私には何が欠けていますか?実際にdoxygenを使ってこれを達成する方法はありますか?
doxywizardでdoxygenを設定していますが、現在Windowsでテスト中です。
編集:ugorenが指摘しているように、マクロをドキュメント化するだけでドキュメントをリンクすることができます。これは私の現在の実装が私のプロジェクトに実際にどのようにあるかです。しかし、もしあれば、私は追加オプションを検討しようとしています。
はいだけでマクロを記録することは可能な解決策であり、これは私が現在やっているものですが、私はそうでなければそれを行うことができる方法があれば疑問に思います。入力していただきありがとうございます – Lefteris
doxygenのドキュメント内でマクロを展開することができます –