Document multiple enumeration/variables with the same description in doxygen

Question

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.

Denise Skidmore · Accepted Answer · 2014-01-14 15:36:09Z

1

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

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

answered Jan 14, 2014 at 15:36

Denise Skidmore

2,4511 gold badge29 silver badges55 bronze badges

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

Comments

albert · Accepted Answer · 2018-12-15 10:41:39Z

0

Member groups may be what you are looking for.

edited Dec 15, 2018 at 10:41

albert

9,2103 gold badges24 silver badges42 bronze badges

answered Aug 26, 2010 at 18:13

Dima

39.6k14 gold badges80 silver badges116 bronze badges

1 Comment

Dennis Miller Over a year ago

Thanks, but it sorta of works. However, it gives me a good place to start.

Collectives™ on Stack Overflow

Document multiple enumeration/variables with the same description in doxygen

2 Answers 2

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related