c++ - 多个参数的 Doxygen 文档

Question

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

我试过了

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

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

如果我将 DISTRIBUTE_GROUP_DOC 设置为 false，那么它可以正常工作，但只有 func1 是可点击的，其他的则不行。

Answer 1

您可以在@brief 之前的一行中使用@name 来创建成员(member)组。

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

如果功能之间的联系可以简单概括，可以在@name 标签后添加一个描述性的名称。