breathe icon indicating copy to clipboard operation
breathe copied to clipboard

dropping enum member of struct, just showing type

Open hannorein opened this issue 4 years ago • 1 comments

I'm having trouble getting breathe (latest release) to document a member of a c struct which is an enum:

struct struct_a{
    int member_a;
    enum ENUM_TYPE {
        ENUM_A = 1,
        ENUM_B = 2
    } member_b;
};

Doxygen lists both member_a and member_b as public members. Is also lists ENUM_TYPE as a public type, both in the HTML and XML outputs. But after going trough breathe, member_b seems to get dropped from the documentation. The type is still listed though. Surprisingly, an anonymous struct, i.e.

struct struct_a{
    int member_a;
    enum {
        ENUM_A = 1,
        ENUM_B = 2
    } member_b;
};

works fine. It appears as an anonymous type and as a member with that anonymous type. I've attached two screenshots which show the rendered output for the two cases.

This looks like a bug to me unless I'm missing something.

with an anonymous enum:

Screen Shot 2019-07-27 at 12 46 55 PM

with a named enum:

Screen Shot 2019-07-27 at 12 47 11 PM

hannorein avatar Jul 27 '19 16:07 hannorein

This might be fixed with #512, released in Breathe v4.17.0. Note that you also need Sphinx 3.x for recent Breathe versions. Could someone try and post results?

vermeeren avatar May 01 '20 19:05 vermeeren