feat: render comment tags as separate sections#86
Merged
Conversation
Replace the bold `@tag` definition-list rendering with a labelled section per tag, mirroring the existing `@since` layout.
Extract CommentTags and render it after params/returns in signatures, after type declarations in member declarations, and after structural panels in top-level reflections. Drop the labeled heading in favour of the same italic style used by @SInCE.
barjin
force-pushed
the
feat/render-tags-as-sections
branch
from
0b43ee3 to
c889b47
Compare
Member
Author
|
B4nan
approved these changes
Jun 22, 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.
Closes #85.
The
@-prefixed block tags were rendered as a bold definition list, which the issue flagged as visually unpleasant. This renders each block tag as its own labelled section, mirroring the existing@sincelayout: a muted uppercase label followed by the content.When a
@deprecatedor@seetag carries no message, a sensible default is shown so the section is never empty; any user-supplied message is used as-is. The@exampletag is no longer rendered.