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部分，其中包含返回值的描述。

安迪

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

1 个答案: