多参数的 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 标记后添加描述性名称。