【问题标题】:How do I make doxygen extract enum values without documenting each member?如何在不记录每个成员的情况下使 doxygen 提取枚举值?
【发布时间】:2012-10-13 14:34:34
【问题描述】:

我有一个简单明了的枚举,不需要记录每个成员。 我仍然希望文档中的所有成员都可以看到可能的值。

有没有办法让 doxygen 提取枚举的所有成员而不将其设置为 EXTRACT_ALL?

有问题的枚举:

/// \brief This enum holds all normal and special keys
enum Key
{
   KEY_A = 'A',
   KEY_B = 'B',
   // etc
};

【问题讨论】:

标签: doxygen


【解决方案1】:

查看member groupingDISTRIBUTE_GROUP_DOC 配置文件选项。

来自DISTRIBUTE_GROUP_DOC 文档:

如果文档中使用了成员分组,并且DISTRIBUTE_GROUP_DOC 标签设置为YES,那么 doxygen 将为组中的其他成员重用组中第一个成员(如果有)的文档。默认情况下,必须明确记录组的所有成员。

另外,记得have \file somewhere

【讨论】:

    猜你喜欢
    • 2013-07-09
    • 2012-08-15
    • 2015-05-17
    • 1970-01-01
    • 2012-11-24
    • 2014-10-07
    • 2010-10-07
    • 2014-04-10
    • 1970-01-01
    相关资源
    最近更新 更多