如何在不记录每个成员的情况下制作doxygen提取枚举值?

时间:2012-10-23 15:40:13

标签: doxygen

我有一个简单的枚举,并不需要记录每个成员。 我仍然喜欢文档中的所有成员,以便人们可以看到可能的值。

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

问题中的枚举:

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

1 个答案:

答案 0 :(得分:1)

查看member groupingDISTRIBUTE_GROUP_DOC配置文件选项。

来自DISTRIBUTE_GROUP_DOC文档:

  

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

另外,请记住have \file somewhere