多个参数的Doxygen文档

Doxygen documentation for multiple parameters

本文关键字：Doxygen 文档 参数      更新时间：2023-10-16

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

我试过

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

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

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

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

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

如果函数之间的关系可以简单概括，则可以在@name标记后添加描述性名称。

相关文章：