Doxygen 记录一组枚举MEBER的组
是否可以记录一组枚举值,与此类似(此示例不起作用):Doxygen 记录一组枚举MEBER的组,doxygen,Doxygen,是否可以记录一组枚举值,与此类似(此示例不起作用): 突出的两个直接因素: 您没有记录MYENUM_SECOND或MYENUM_SECOND,因为您没有用有效的doxygen注释包装它们:您应该编写///{而不是/{ 您的MYENUM_FOURTH的文档应该是 ///< third member documentation 通过在配置文件中设置DISTRIBUTE\u GROUP\u DOC=YES。请注意,我已经从您的示例中删除了\name命令。我为愚蠢的错误感到抱歉,我将示例放得有
突出的两个直接因素:
- 您没有记录
或MYENUM_SECOND
,因为您没有用有效的doxygen注释包装它们:您应该编写MYENUM_SECOND
而不是///{
/{
- 您的MYENUM_FOURTH的文档应该是
///< third member documentation
通过在配置文件中设置
。请注意,我已经从您的示例中删除了DISTRIBUTE\u GROUP\u DOC=YES
命令。我为愚蠢的错误感到抱歉,我将示例放得有点匆忙。我最初的想法是在组上方加一个粗体标题,而不是为两个membe都提供相同的文档rs,因此有了“@name”标记。在这种情况下,似乎不可能使用“@name”标记。但拥有相同的doc也是一个好主意。似乎doxygen同时允许/@{和///@{是的,正如doxygen文档中的一个例子所示-但它们可能意味着不同的事情?我想发布这个例子,但字符限制不允许我发布。您可以随时编辑您的问题以添加更多代码示例。而不是“标题”,为什么不记录\name
本身?@WernerHenze此问题的答案已被接受。如果您有其他问题,请创建一个新问题。enum
///< third member documentation
enum MyEnum { MYENUM_FIRST, ///@{ /// These two members' description MYENUM_SECOND, MYENUM_THIRD, ///@} MYENUM_FOURTH, ///< third member documentation MYENUM_FIFTH };