doxygen defgroup导致空组

时间:2012-03-26 14:04:29

标签: c++ doxygen doxygen-addtogroup

我有一个C ++类实现文件,它有一些常量。常量出现在类方法实现之前。我想把常量分组在一起。我的组和说明显示在“模块”选项卡中,但组都是空的。存在详细描述但没有组成员。小组是这样的:

//!
//! @defgroup MY_FOOBARS list of foobar constants
//!
//! This is a more detailed description of the role
//! played by the foobar constants
//!
//! @{

static const char* FOOBAR1  = "AA";                 //!< A short summary of FOOBAR1
static const char* FOOBAR2  = "BB";                 //!< A short summary of FOOBAR2

//! @}

我也尝试使用@addtogroup或@ingroup明确添加组成员,但似乎都不起作用。

有关为什么这不起作用以及我需要做些什么才能使其发挥作用的任何想法?

克里斯指出

编辑拼写错误

为了完成这项工作,我需要在我的doxygen配置中设置EXTRACT_STATIC = YES。

2 个答案:

答案 0 :(得分:1)

您的文档似乎具有正确的结构(例如,请参阅doxygen手册中的member groups)。但是,您似乎使用//|<作为FOOBAR1FOOBAR2的文档。这似乎不是valid doxygen markup。这应该是//!<吗?

答案 1 :(得分:1)

为了完成这项工作,我需要在我的doxygen配置中设置EXTRACT_STATIC = YES。如果不这样做,我的组中的静态变量将不会包含在文档中。