doxygenenum does not include list of enumerators/their documentation about breathe HOT 6 CLOSED

Hey,

Thanks for the report and thanks for giving breathe a go. Been a bit of a slow response as I've had to navigate my company's proxy server to be able to send to github.

I've just pushed a (slightly alpha-y) update to the repos which will show enums in the final output. One slight issue is that it always prints a separator after the enum name even when there isn't a description. Bit more work required there, but I'd be happy to know if it is in the right ball park for you.

All the best,
Michael

from breathe.

Fantastic! This is exactly the right ballpark. One nice tweak would be if "Enumerator:", "Values:", or something along those lines could be put into the output before the beginning of the list.

Best,
Marti

from breathe.

I've added "enum" to the enumerator titles. Do you think that is satisfactory?

Cheers,
Michael

from breathe.

Thanks for being so responsive to reports!

Sorry for not being clear -- I was thinking that this could be placed before the actual list of enumerator values, in the same way "Parameters" appears before the list of a function's parameters. For instance, this

/**
 * Description.
 * @see relatedFunction()
 */
typedef enum {ENUEMRATOR1, ENUMERATOR2} some_t;

might get turned into something like

some_t
    Description.

    See:
        relatedFunction()

    Values:
        - ENUMERATOR1
        - ENUMERATOR2

As is, I'm worried that some people might get confused and e.g. think that the list of enumerators is under "See".

from breathe.

Hey,

Thanks for the clarification. I confess I knew what you meant but didn't see the need until your example. Thank you for taking the time.

I've pushed a version that should do as you suggest.

Cheers,
Michael

from breathe.

Hi,

Looking good, thanks for the fix.

Marti

from breathe.