feat(theme): render @example JSDoc tags in member bodies#23
Merged
avivkeller merged 1 commit intowebpack:mainfrom Mar 14, 2026
Merged
feat(theme): render @example JSDoc tags in member bodies#23avivkeller merged 1 commit intowebpack:mainfrom
avivkeller merged 1 commit intowebpack:mainfrom
Conversation
Resolves webpack#5. Adds a renderExamples() helper that extracts @example block tags from TypeDoc reflections and appends them as headed sections (at headingLevel + 1) after the member description. Multiple @example tags are rendered with numbered headings (Example 1, Example 2, ...). Empty example bodies are filtered out.
avivkeller
approved these changes
Mar 14, 2026
Contributor
Author
|
Thanks! |
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
2 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.
Summary
Adds support for rendering @example JSDoc tags in generated member bodies and previously these tags were silently dropped. As of now they appear as headed sections after the member description, following the same patterns already used for @deprecated and @returns.
Closes #5.
What kind of change does this PR introduce?
Feature - which renders @example JSDoc tags in generated member bodies.
Did you add tests for your changes?
No. But verified manually by adding an @example tag to webpack/types.d.ts, running npm run generate-docs, and confirming the output in pages/v5.x.
Does this PR introduce a breaking change?
No only members with @example tags are affected rest all existing output is unchanged.
If relevant, what needs to be documented once your changes are merged or what have you already documented?
No documentation needed.
Use of AI
No