Question

考虑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 bug吗？

Answer 1

从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。

Answer 2

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

Doxygen：为什么@name会将所有以下函数视为已记录？

2 个答案: