Doxygen:为什么@name使以下所有功能都被视为文档

Doxygen: Why does @name makes all following functions be considered as documented?

本文关键字：功能 文档 为什么 @name Doxygen      更新时间：2023-10-16

考虑doxygen记录的这段代码：

class A
{
public:
    /** func1 description */
    void func1();
    void func2();
};

因为我在 doxyfile 中将WARN_IF_UNDOCUMENTED设置为YES，所以此报告Warning: Member func2() (function) of class A is not documented. 。好

现在，如果您添加一个 @name 标签来全局描述我的两个函数：

class A
{
public:
    /** @name A's standard functions */
    /** func1 description */
    void func1();
    void func2();
};

警告不再显示。但func2仍然绝对没有记录。

有什么选项我没有设置正确吗？这是氧气虫吗？

来自 doxygen 文档：

//!@{
//! one description for all members of this group 
//! (because DISTRIBUTE_GROUP_DOC is YES in the config file)  <-- the interesting tidbit
#define A 1
#define B 2
void glob_func();
//!@}

组内函数的隐式文档的创建由配置文件中的全局宏DISTRIBUTE_GROUP_DOC控制。

在 doxygen GUI 中，您可以在页面底部附近的专家窗格中找到DISTRIBUTE_GROUP_DOC主题"项目"。

这是一个

Doxygen 1.8.13 错误。正如Michaël Roy所建议的那样，迁移到Doxygen 1.8.15可以解决这个问题。

相关文章：