【问题标题】:doxygen member grouping not working as in documentationdoxygen 成员分组不像文档中那样工作
【发布时间】:2013-03-06 09:20:55
【问题描述】:

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

//@{
/** 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 类”不存在)。在这一点上我不知道。我正在使用最新版本。

【问题讨论】:

  • 您是否将 DISTRIBUTE_GROUP_DOC 设置为 YES?
  • @doxygen 请将其发布为答案,以便我投票、确认和崇拜您。
  • 作为横向说明,我认为在 Doxygen 文档页面中应该有一条评论,该功能不适用于默认 Doxyfile,并且必须启用该选项。

标签: doxygen


【解决方案1】:

记得将 DISTRIBUTE_GROUP_DOC 设置为 YES。

我将此作为答案发布,因为看来@doxygen 不会这样做,信用到期

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2011-01-11
    • 1970-01-01
    • 2013-04-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多