Doxygen:记录函数指针类型的参数(ANSI-C)

Question

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

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

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

有没有办法让doxygen在函数type-defs中添加参数文档？

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);

在输出中，它创建了简要描述和详细描述、具有参数a和b的Parameters部分以及具有返回值描述的Returns部分。

安迪