6

ドキュメントによると、これはクラスの同じメンバーにドキュメントを付与するのに十分なはずです

//@{
/** Same documentation for both members. Details */
void member1();
void member2();
//@}

私の場合もよく似ています。私は持っている

  //@{
  /*! \brief comment blah blah
   *  \param one param
   *  \param two param
   *  \return return
   Foo &member1(MyEnum one, Foo & two)
   Bar &member2(MyEnum one, Bar & two)
   Baz &member3(MyEnum one, Baz & two)
   //@}

試してみましたが、最初のものだけで説明が得られます。何か不足していますか？

編集：わかりました、私は彼らの例を試しました

/** A class. Details */
class Test
{
  public:
    //@{
    /** Same documentation for both members. Details */
    void func1InGroup1();
    void func2InGroup1();
    //@}

    /** Function without group. Details. */
    void ungroupedFunction();
    void func1InGroup2();
  protected:
    void func2InGroup2();
};

void Test::func1InGroup1() {}
void Test::func2InGroup1() {}

/** @name Group2
 *  Description of group 2. 
 */
///@{
/** Function 2 in group 2. Details. */
void Test::func2InGroup2() {}
/** Function 1 in group 2. Details. */
void Test::func1InGroup2() {}
///@}

/*! \file 
 *  docs for this file
 */

//!@{
//! one description for all members of this group 
//! (because DISTRIBUTE_GROUP_DOC is YES in the config file)
#define A 1
#define B 2
void glob_func();
//!@}

そして、提案された結果とは異なる結果を生み出します。繰り返しますが、グループ化も他の多くの説明も見当たりません (たとえば、「A クラス」はありません)。現時点ではわかりません。最新バージョンを使用しています。

4

1 に答える 1

15

DISTRIBUTE_GROUP_DOC を YES に設定することを忘れないでください。

@doxygenはそれをしないように見えるので、これを回答として投稿します。クレジットが必要な場合はクレジット

于 2013-11-20T12:57:11.503 に答える