doxygenで設定マクロを文書化します。そのマクロはソースコードでは定義されていませんが、コンパイラ定義の設定を使用して定義する必要があります。doxygenで設定マクロを文書化してください
/*! \def MY_CONFIG_MACRO
\brief Brief
Details.
*/
しかしそのドキュメント:私は私はdoxygenをマニュアルに見出され、以下のようなものを試みない定義がないので
は、(Iは、条件付きコンパイルのマクロを使用しているヘッダにこのスニペットを追加しました)生成されたHTMLファイルには表示されません。上記がうまくいかない理由は何ですか?コンパイラで定義されたマクロを使用するコンテキストでどのように文書化できますか?
doxygenの設定ファイルでは、追加:
どこかのソースコード内のPREDEFINED = IN_DOXYGEN
、追加:
/*
Exporting cmake compilation flags to doxygen,
so they get documented.
*/
#ifdef IN_DOXYGEN
#define MY_CONFIG_MACRO
#endif /* IN_DOXYGEN */
私はそのような可能性は疑います。私は、それを必要とするコンポーネントの一般的なドキュメントでこの要件を言及します。これは、関数、グループ、またはメインページのドキュメントでもあります。 –
うーん、私はこれが正しい方法であると私は同意するだろう。あなたは[mcve]を試しましたか?たぶん、doxygen-configに何か問題がありますか? – Olaf
@Olaf:新しいdoxywizard設定ファイルを使って、空のヘッダファイルで上記のスニペットを試しました。 Doxygenは "警告:MY_CONFIG_MACROが未知の定義のドキュメント"を発見しました。 HTMLは空です。マクロを定義すると、ドキュメントが表示されます。 – Silicomancer