Documenting Enumerations Using doxygen

Question

The html documentation created by doxygen for enumerations lists the enumeration on the left and the documentation on the right. However, I need fairly detailed documentation for each value, and some of them are very long, so the right column with the documentation looks far right, and it looks very bad. Is it possible to make the documentation for each value lower or higher than the value, and not on the right?

Answer 1

I am using Doxygen 1.7.5.1. I had a similar situation ... I had a listing of about 1000 members that I generated from a spreadsheet. I wanted the integer value to be on the right and the Doxygen bit above the member.

All I did was use a triple slash above the member name. For multi-line comments, I inserted a line break in HTML format where necessary. I just made the first verse, but I think it is pretty obvious. Note: the first line is interrupted due to the period. The following lines are not.

/// /// \file test.h /// \brief Test of Doxygen enum commenting. /// //! A test of Doxygen commenting. typedef enum _DOXYGEN_TEST { /// This is a single line comment. Member_001, // 1 /// This is a mutli-line comment. /// 'Twas brillig, and the slithy toves <br> /// Did gyre and gimble in the wabe; <br> /// All mimsy were the borogoves, <br> /// And the mome raths outgrabe. <br> /// "Beware the Jabberwock, my son! <br> /// The jaws that bite, the claws that catch! <br> /// Beware the Jubjub bird, and shun <br> /// The frumious Bandersnatch!" /// /// He took his vorpal sword in hand: /// Long time the manxome foe he sought-- /// So rested he by the Tumtum tree, /// And stood awhile in thought. /// /// And as in uffish thought he stood, /// The Jabberwock, with eyes of flame, /// Came whiffling through the tulgey wood, /// And burbled as it came! /// /// One, two! One, two! and through and through /// The vorpal blade went snicker-snack! /// He left it dead, and with its head /// He went galumphing back. /// /// "And hast thou slain the Jabberwock? /// Come to my arms, my beamish boy! /// O frabjous day! Callooh! Callay!" /// He chortled in his joy. /// /// 'Twas brillig, and the slithy toves /// Did gyre and gimble in the wabe; /// All mimsy were the borogoves, /// And the mome raths outgrabe. Member_002, // 2 } Doxygen_test; 

Received Doxygen generated file:

Answer 2

With doxygen 1.5.5, I was not able to reproduce the behavior you described. I get enum documentation similar to the parameter list documentation.

What I am observing is consistent with the Doxygen documentation for the \ enum command and its rendering .

Answer 3

I also cannot reproduce this. Can you post an enumeration and related comments using doxyfile (doxygen config)? Maybe pastebin url?