Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dropping enum member of struct, just showing type #447

Open
hannorein opened this issue Jul 27, 2019 · 1 comment
Open

dropping enum member of struct, just showing type #447

hannorein opened this issue Jul 27, 2019 · 1 comment
Labels
bug Problem in existing code code Source code

Comments

@hannorein
Copy link

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

@vermeeren
Copy link
Collaborator

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 vermeeren added bug Problem in existing code code Source code labels May 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Problem in existing code code Source code
Projects
None yet
Development

No branches or pull requests

2 participants