Resolve full title for doxygenpage and doxygengroup and allow for omitting the title all together #939
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.
Currently, the
doxygengroup
ordoxygenpage
directives will render a line likeor
before the actual description and content, where
page_id
andgroup_id
are the ids as specified in the corresponding doxygen commands, e.g.:What one would rather have rendered in the .rst output is the full titles, not just the ids.
This set of patches addresses that problem by resolving the full title of the
group
orpage
if it is available in the doxygen xml ouput.Moreover, the second patch introduces a new option for the
doxygenpage
anddoxygengroup
directives:no-title
.The purpose of this flag is to allow for leaving out just the title of a page or group, which is useful if the actual title is included in the .rst document that calls the directive. For instance:
would render such that the description and content smoothly follow the text in the .rst file without any doxygen-specific title for
group_id
. Note, that when the group contains additional doxygen@name
commands (member group names) that further sub-group the members of a group, they are still shown. So sub-grouping/member groups are still working as before.I introduced the
no-title
option since when usingcontent-only
all sub-group names where lost together with the actual group/page title. But I wanted to keep the sub-group names while still leaving out the title.I believe this option and the expansion to the full group/page title may be useful for others as well.