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

doxygenunion does not work as intended #793

Open
dmg0345 opened this issue Jan 30, 2022 · 2 comments · May be fixed by #799
Open

doxygenunion does not work as intended #793

dmg0345 opened this issue Jan 30, 2022 · 2 comments · May be fixed by #799

Comments

@dmg0345
Copy link

dmg0345 commented Jan 30, 2022

The following union:

/**
 * @brief Timer event details.
 */
typedef union
{
    /**
     * @brief Event details for an event of type.
     */
    uint8_t timeout;
} timer_event_details_t;

When documented with doxygenunion:: and :members: it does not display at all nor seems to raise any error. When I switch to doxygenstruct an error is raised stating that the structure can't be found, which is what I would expect since it is an union.

When :members: is not included it seems to work, however I do not understand why the #include ... part is displayed.

.. doxygenunion:: timer_event_details_t

image

If I add :outline:, it displays without the #include ..., but it also removes the documentation, so I do not think there is a workaround:

.. doxygenunion:: timer_event_details_t
    :outline:

image

Is doxygenunion working as expected?

@jakobandersen jakobandersen linked a pull request Feb 6, 2022 that will close this issue
@jakobandersen
Copy link
Collaborator

Thanks for reporting.

Is doxygenunion working as expected?

Short answer: no. Your report reminded me about #698, and I have made an initial experimental PR for progressing on this. Can you try it out and see how it works for you? It should now work exactly like a .. doxygenclass:: directive.

@dmg0345
Copy link
Author

dmg0345 commented Feb 7, 2022

Just tried with your branch @jakobandersen, seems to be working OK now, thanks.

.. doxygenunion:: timer_config_details_t
    :members:

Displays like:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants