CODEWITHSUNDEEP
doxygen
Dennis Miller
Dennis Miller

Reputation: 1002

Document multiple enumeration/variables with the same description in doxygen

Is it possible to document multiple enumeration/variables with the same documentation?

For example:

enum
{
   /// Description of Values
   VALUE_1 = 0,
   VALUE_2 = 1,
   VALUE_3 = 2
};

This results only VALUE_1 getting described by the doxygen description, when in reality, I want all three values to have the same description. The only way to get around this is copy and paste the description for every value.

Upvotes: 1

Views: 1033

Answers (2)

Dima
Dima

Reputation: 39419

Member groups may be what you are looking for.

Upvotes: 0

Denise Skidmore
Denise Skidmore

Reputation: 2416

You can document the whole enum instead of the individual values.

/// Description of Values
enum
{
   VALUE_1 = 0,
   VALUE_2 = 1,
   VALUE_3 = 2
};

Upvotes: 1

Related Questions