doxygen - 组记录一组枚举成员

Question

是否可以记录一组枚举值，类似于此（此示例不起作用）：

enum MyEnum
{
  MYENUM_FIRST,
//@{
//@name These two members' description
  MYENUM_SECOND,
  MYENUM_THIRD,
//@}

  MYENUM_FOURTH, ///third member documentation
  MYENUM_FIFTH
};

Answer 1

突出的两件直接的事情：

• 你没有记录MYENUM_SECOND，或者MYENUM_THIRD因为你没有用有效的 doxygen 注释包装它们：你应该写///@{而不是//@{.

• 您的文档MYENUM_FOURTH应该是

  ///< third member documentation
  

  否则你正在记录MYENUM_FIFTH而不是MYENUM_FOURTH.

我可以使用以下代码获取两者MYENUM_SECOND的文档MYENUM_THIRD

enum MyEnum
{
  MYENUM_FIRST,
  ///@{
  /// These two members' description
  MYENUM_SECOND,
  MYENUM_THIRD,
  ///@}

  MYENUM_FOURTH, ///< third member documentation
  MYENUM_FIFTH
};

并通过DISTRIBUTE_GROUP_DOC = YES在配置文件中进行设置。请注意，我\name已从您的示例中删除了该命令。