请考虑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吗?
从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”,位于页面底部附近。
这是一个Doxygen 1.8.13错误。正如MichaëlRoy提出的那样,迁移到Doxygen 1.8.15解决了这个问题。