Skip to content

[WIP] Move union directive to be class-like#799

Open
jakobandersen wants to merge 1 commit intobreathe-doc:mainfrom
jakobandersen:union
Open

[WIP] Move union directive to be class-like#799
jakobandersen wants to merge 1 commit intobreathe-doc:mainfrom
jakobandersen:union

Conversation

@jakobandersen
Copy link
Copy Markdown
Collaborator

@jakobandersen jakobandersen commented Feb 6, 2022

The union directive is currently classified as an "item", similar to typedefs, enums, and enumerators. However, formally it is a class type (https://en.cppreference.com/w/cpp/language/type), and in terms of documentation I think it should be handled as classes are. See also #698.

The HTML for the Breathe docs are unaffected by this change.

Fixes #793?

TODOs:

  • More extensive testing. Directive refactoring #698 mentions something about namespacing that I don't remember the details of, but should be double checked.'
  • Docugmentation update?
  • Changelog entry.

@dmg0345
Copy link
Copy Markdown

dmg0345 commented Jun 28, 2022

Any chance this could be merged?

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 this pull request may close these issues.

doxygenunion does not work as intended

2 participants