Marc Mutz - mmutz
Marc Mutz - mmutz

Reputation: 25313

doxygen: how do I document \enum values out-of-line?

To be precise: I know how to dox enums at the point of declaration, I want to dox them out-of-line instead.

I want to keep the header file free of doxygen comments; they're all in the .cpp file. This is not a problem for functions, classes, typedefs and so on. I can also document the enum itself like this:

/*!
  \enum MyClass::MyEnum

  Foo Bar Baz

  \value FirstEnumValue <- doesn't work
*/

but how do I document the values of the enum there?

Thanks!

Upvotes: 4

Views: 5359

Answers (1)

rve
rve

Reputation: 6055

You need to use \var according to the docs

Upvotes: 7

Related Questions