Question

根据文档，这应该足以将文档授予类的相同成员

//@{
/** 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();
//!@}

它产生的结果与proposed result不同。我再次看到没有分组，也没有其他许多描述（例如“A类”不存在）。此时我不知道。我使用的是最新版本。

Answer 1

请记住将DISTRIBUTE_GROUP_DOC设置为YES。

我发布这个作为答案，因为看起来@doxygen将不会这样做，信用到期的信用

doxygen成员分组不像文档中那样工作

1 个答案: