Fixed(docs): use doxygenclass for template class members in RST generation#477
Open
AAmbuj wants to merge 1 commit into
Open
Fixed(docs): use doxygenclass for template class members in RST generation#477AAmbuj wants to merge 1 commit into
AAmbuj wants to merge 1 commit into
Conversation
…ation Breathe cannot resolve template member functions via doxygenfunction when Doxygen does not emit standalone XML entries for inline template method definitions. Detect template class members in extract_api_items.py and emit doxygenclass with :members: instead, with deduplication to avoid documenting the same class multiple times.
AAmbuj
requested review from
LittleHuba,
bemerybmw,
castler,
crimson11,
hoe-jo and
limdor
as code owners
LittleHuba
reviewed
Jun 3, 2026
Comment on lines
+295
to
+306
| # Strip template parameters to get the raw class name for the | ||
| # doxygenclass directive. Handle nested templates by removing | ||
| # outermost balanced angle brackets from each segment. | ||
| segments = class_part.split('::') | ||
| clean_segments = [] | ||
| for seg in segments: | ||
| idx = seg.find('<') | ||
| if idx != -1: | ||
| seg = seg[:idx] | ||
| clean_segments.append(seg) | ||
|
|
||
| return '::'.join(clean_segments) |
Contributor
There was a problem hiding this comment.
What about partial template specializations where a specialization contains namespace separators? (a::b<c::d, T>)
They will mess this algorithm up.
gdadunashvili
approved these changes
Jun 3, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Breathe cannot resolve template member functions via doxygenfunction when Doxygen does not emit standalone XML entries for inline template method definitions. Detect template class members in extract_api_items.py and emit doxygenclass with :members: instead, with deduplication to avoid documenting the same class multiple times.