Apply field-list and admonition handling to classes and unions #764
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Most declarations use the
description()
method to render the brief and detailed descriptions. That function which pulls up field-lists and admonitions from the detailed description, such that Sphinx can process the field-lists.But classes and unions render their content through
visit_compounddef()
which didn't process the detailed description.This PR factors out the handling so both methods can apply the handling.
This incidentally also means that classes and unions now get affected by
breathe_order_parameters_first
which, despite its name, determines the order between field-lists in general (including template parameter documentation) and admonitions.Fixes #761.
As test case:
The concept declaration seems to no be handled correctly by Doxygen, so it should be checked at a later stage.