How to document enum class values out of line in source with Doxygen

Question

I am trying to document an enum class values out of line in the *.cpp file:

Consider:

class SomeClass
{
    enum class MyEnum
    {
        val1
    };
};

and out-of-line Doxygen documentation in the *.cpp file:

/*!
 * \class SomeClass
 * ...
 *\

/*!
 * \enum SomeClass:MyEnum
 * This works fine.
 */

/*!
 * \var SomeClass::MyEnum::val1
 * And this does not...
 */

The third comment section fails with this message:

warning: no matching class member found for SomeClass::MyEnum::val1

I have tried many variations suggested in other similar questions and answers but to no avail. I can either make the enum class a regular enum or put the documentation inline to the header. Any other options?

gmug · Accepted Answer · 2017-01-06 09:01:00Z

1

Try following:

class SomeClass
{
    enum class MyEnum
    {
        val1
    };
};

and in the cpp file:

/*!
 * \class SomeClass
 * ...
 */

/*!
 * \enum SomeClass:MyEnum
 * This works fine.
 */

/*!
 * \var SomeClass::val1
 * And this works now, too...
 */

Note that I removed the tag name of the enumeration.

answered Jan 6, 2017 at 9:01

gmug

8256 silver badges12 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Resurrection Over a year ago

Thanks, I mention that option in OP. It works with regular enums but not with enum class. Anyway, I have abandoned Doxygen and moved to QDoc as I use Qt primarily.

gmug Over a year ago

Oh, I tried exactly the code I posted, and it worked for me even with enum class.

Resurrection Over a year ago

Interesting, you are right. That is not very intuitive and will not work for multiple enum classes with the same values but it is the answer for current Doxygen.

Collectives™ on Stack Overflow

How to document enum class values out of line in source with Doxygen

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related