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

Question

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

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

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

有没有办法让doxygen添加参数文档到函数类型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);

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

安迪