According to the docs, this should be sufficient to grant documentation to the same members of a class
//@{
/** 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 one. Am I missing 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 it produces a result that is different from their proposed result. Again, I see no grouping, nor many other descriptions (e.g. the "A class" is not there). At this point I don't know. I am using the latest version.
Remember to set DISTRIBUTE_GROUP_DOC to YES.
I post this as an answer as it appears @doxygen will not do it, credit where credit is due
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With