【问题标题】:doxygen defgroup results in empty groupdoxygen defgroup 导致空组
【发布时间】:2012-04-10 01:03:24
【问题描述】:

我有一个包含一些常量的 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 显式添加组成员,但似乎都不起作用。

对为什么这不起作用以及我需要做些什么来使它起作用有什么想法吗?

EDIT克里斯指出的错字

解决方案

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

【问题讨论】:

  • 在下面看到你的答案了吗?您需要勾选它以显示为解决方案。

标签: c++ doxygen doxygen-addtogroup


【解决方案1】:

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

【讨论】:

    【解决方案2】:

    您的文档似乎具有正确的结构(例如,请参阅 doxygen 手册中的member groups)。但是,您似乎使用//|&lt; 来记录FOOBAR1FOOBAR2。这似乎不是valid doxygen markup。这实际上应该是//!&lt; 吗?

    【讨论】:

    • 好发现!我已经在上面进行了编辑。但它没有帮助。我确实想知道组元素是否不支持“事件后”注释,并尝试将它们放在元素前面,但这也无济于事。
    • 已修复!为了完成这项工作,我需要在我的 doxygen 配置中设置 EXTRACT_STATIC=YES。
    • 太棒了。或许您应该将此作为答案发布并接受。
    猜你喜欢
    • 2015-06-15
    • 2018-01-01
    • 2020-04-25
    • 2021-01-05
    • 2017-07-23
    • 2019-06-08
    • 1970-01-01
    • 1970-01-01
    • 2023-03-08
    相关资源
    最近更新 更多