多个参数的Doxygen文档

Question

如何为一组具有不同参数的函数创建文档（但我希望它们共享相同的文档）？

我试过

/// @brief ...
/// 
/// @{
void func1(int a);
void func2(float b, void *c);
/// @}

但这是冗余地将文档放在每个函数上，如果我尝试记录参数，doxygen会警告我。

如果我使用DISTRIBUTE_GROUP_DOC为false，那么它可以正常工作但只有func1是可点击的，而不是其他的。

Answer 1

您可以在@brief之前的行上使用@name来创建成员组。

/// @name
/// @brief
/// Description of two functions
/// @{
void func1(int a);
void func2(float b, void *c);
/// @}

如果函数以您可以简要概括的方式相关，则可以在@name标记之后添加描述性名称。