Doxygen:为什么@name会将所有后续功能视为记录?

问题描述 投票:0回答:2

请考虑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吗?

c++ doxygen
2个回答
0
投票

从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,主题为“Project”,位于页面底部附近。


0
投票

这是一个Doxygen 1.8.13错误。正如MichaëlRoy提出的那样,迁移到Doxygen 1.8.15解决了这个问题。

© www.soinside.com 2019 - 2024. All rights reserved.