Fix doxygen groups in many places #14157
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It turns out that grouping using @{ and @} only works if it is inside a
doxygen comment like /** */ and not inside a normal comment /* */. This
meant that most of our groupings were incorrect.
- fix @{ and @}
- avoid using /*! which is equivalent to /**
- make some formatting prettier
kronbichler
reviewed
Jul 21, 2022
| @@ -383,7 +383,7 @@ levels, and accessors for objects of lower dimensionality do not have a | |||
| @ingroup grid | |||
| */ | |||
|
|
|||
| //@} | |||
| /** @} */ | |||
There was a problem hiding this comment.
To me, this looks not as nice as would
Suggested change
| /** @} */ | |
| /// @} |
As far as I know, doxygen should also pick up /// comments. If others prefer the version here, I am happy to support that as well.
There was a problem hiding this comment.
My motivation was making it symmetric with the opening @{ which can be grouped with @name etc.
drwells
approved these changes
Jul 22, 2022
mkghadban
pushed a commit
to OpenFCST/dealii
that referenced
this pull request
Sep 8, 2022
Fix doxygen groups in many places
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
It turns out that grouping using @{ and @} only works if it is inside a
doxygen comment like /** / and not inside a normal comment / */, which we use all over the plae. This meant that most of our groupings were incorrect.
fixes #14095
It also magically fixes some other stuff:
It removes a gigantic amount of unrelated stuff from https://www.dealii.org/developer/doxygen/deal.II/group__Exceptions.html
and probably more. :-)