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来自您示例的命令。