Adds argument to doxygengroup to display just the description. #718
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
vermeeren
added
code
vermeeren
requested changes
Sep 18, 2021
There was a problem hiding this comment.
@intelkevinputnam Could you also update documentation for doxygengroup and doxygennamespace directives?
- documentation/source/directives.rst (arg only)
- documentation/source/group.rst (arg + example)
- documentation/source/namespace.rst (arg + example)
Doc also serves as tests and catching regressions via comparisons. Patch itself seems good to me.
Thanks!
Edit: You probably also want to rebase on master so CI works again.
vermeeren
reviewed
Sep 18, 2021
intelkevinputnam
force-pushed
the
kp-add-description-only
branch
2 times, most recently
from
f30078b
to
2ae05ae
Compare
vermeeren
force-pushed
the
kp-add-description-only
branch
from
2ae05ae
to
22e7138
Compare
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
vermeeren
force-pushed
the
kp-add-description-only
branch
from
22e7138
to
901ad06
Compare
vermeeren
approved these changes
Feb 14, 2022
There was a problem hiding this comment.
@intelkevinputnam Apologies for the long wait, the changes you made are great, many thanks for those!
Merging now.
michaeljones
pushed a commit
that referenced
this pull request
Feb 14, 2022
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.
Any doxygen directive that uses the _DoxygenContentBlockDirective can now display just the description, like so:
I frequently build up groups from their components, so its useful to be able to display just the description.
Signed-off-by: Kevin Putnam kevin.putnam@intel.com