feat(processor): append @example tags to member description body #5#22
Open
Katari-8055 wants to merge 2 commits intowebpack:mainfrom
Open
feat(processor): append @example tags to member description body #5#22Katari-8055 wants to merge 2 commits intowebpack:mainfrom
Katari-8055 wants to merge 2 commits intowebpack:mainfrom
Conversation
avivkeller
requested changes
Mar 13, 2026
Member
avivkeller
left a comment
There was a problem hiding this comment.
This belongs in the theme, not the processor
Contributor
Author
Thanks for the clarification! That makes sense. I'll move the implementation to the theme instead of the processor and push an update shortly. |
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
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 #5
Summary
This PR improves the visibility of code examples in the generated documentation by moving @example block tags into the main reflection body (summary). By appending these examples directly to the reflection's primary description during the processing phase, we ensure they are always rendered in the final output, even when the theme is configured to hide standard block tags. This ensures that usage examples are always accessible to developers without requiring changes to the theme's core visibility settings.
What kind of change does this PR introduce?
feat (feature for the documentation processor)
Did you add tests for your changes?
The changes were manually verified by adding a demo @example tag in webpack/types.d.ts, running npm run generate-docs, and confirming that the example appeared in the generated .md files inside the pages/v5.x directory.
Does this PR introduce a breaking change?
No.
If relevant, what needs to be documented once your changes are merged or what have you already documented?
No external documentation is required. This change automatically enhances how existing and future @example JSDoc tags are rendered in the Markdown output.
Use of AI
Yes, for research purpose !