2013-03-06 55 views
4

根据该文档,这应该是足以授予文档,一类doxygen的成员分组不工作

//@{ 
/** 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 
*/ 

//[email protected]{ 
//! 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(); 
//[email protected]} 

而且它产生的结果是从他们的proposed result不同。我再次看到没有分组,也没有其他许多描述(例如“A类”不在那里)。此时我不知道。我正在使用最新版本。

+6

是否已经设置DISTRIBUTE_GROUP_DOC为YES? – doxygen 2013-03-07 19:04:56

+1

@doxygen请把它作为答案发布,以便我可以upvote,确认和崇拜你。 – 2013-03-08 08:12:11

+0

作为一个侧面说明,我认为在Doxygen文档页面中应该有一个注释,该功能不适用于默认的Doxyfile,并且该选项必须启用。 – 2013-03-08 08:13:56

回答

9

记得将DISTRIBUTE_GROUP_DOC设置为YES。

我张贴这是因为它出现@doxygen不会做一个答案,信贷,信贷是由于