According to the docs, this should be enough to provide documentation to the same class members
//@{ /** Same documentation for both members. Details */ void member1(); void member2(); //@}
My case is very similar. I have
//@{ /*! \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) //@}
I tried, but I get the description only on the first. Did I miss something?
Edit : Ok, I tried their example
/** 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(); // !@ }
And he gives a result different from his proposed result . Again, I do not see the grouping and many other descriptions (for example, "class A" does not exist). I donβt know at the moment. I am using the latest version.
source share