c - Doxygen：记录函数指针类型的参数（ANSI-C）

Question

我的代码需要一些函数指针类型，例如

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

我想记录函数参数的语义，但语句\param[in,out]旁边的a\brief似乎并没有添加额外的文档。

有没有办法让 doxygen 添加参数文档到函数类型定义？

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部分，以及一个带有返回值描述的部分。

安迪