4

これと同様に、列挙値のグループを文書化することは可能ですか (この例は機能しません):

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

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

1 に答える 1

1

目立った2つの直接的なこと:

  • 文書化していないMYENUM_SECONDMYENUM_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あなたの例からコマンドを削除したことに注意してください。

于 2012-04-13T12:43:28.387 に答える