c - Doxygen: 関数ポインター型のパラメーターの文書化 (ANSI-C)

Question

私のコードには、次のような関数ポインター型が必要です

/**
 * \brief Callback function type "foo"
 */
typedef int (*foo)(int a, int b);

関数の引数のセマンティクスを文書化したいのですが、\param[in,out]次の\briefステートメントは追加の文書を追加していないようです。

doxygen add パラメータのドキュメントを関数型定義に取得する方法はありますか?

どんな助けでもTIA！

Answer 1

\param を配置したときに正確に何を試みたかは、あなたの質問からは明らかではありません。

以下は私にとってはうまくいきます（doxygen 1.8.6を使用）：

/**
 * \brief Callback function type "foo"
 *
 * A longer description of foo.
 * \param a Description for a
 * \param b Description for b
 * \return Description for return value
 */
typedef int (*foo)(int a, int b);

出力では、簡単な説明と詳細な説明、Parametersパラメーター a と b を含むReturnsセクション、および戻り値の説明を含むセクションが作成されます。

アンディ