feat(typedoc): treat accessor reflections as properties#15
Merged
avivkeller merged 2 commits intowebpack:mainfrom Mar 13, 2026
Merged
feat(typedoc): treat accessor reflections as properties#15avivkeller merged 2 commits intowebpack:mainfrom
avivkeller merged 2 commits intowebpack:mainfrom
Conversation
avivkeller
approved these changes
Mar 13, 2026
avivkeller
changed the title
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
This PR updates the TypeDoc generation process to treat accessor reflections (get/set) as regular properties.
In TypeScript, accessors behave like properties from the consumer’s perspective, but TypeDoc currently renders them in a separate Accessors section. This leads to inconsistent documentation structure and makes it harder to read property information.
This change converts accessor reflections to ReflectionKind.Property during the documentation build process. The property type and comments are inferred from the getter signature when available, otherwise from the setter parameter.
This ensures that accessors appear alongside other class properties in the generated documentation.
Closes #14
What kind of change does this PR introduce?
feat improves documentation generation by treating accessors as properties.
Did you add tests for your changes?
No.
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 additional documentation changes are required. The change only improves how accessors appear in the generated documentation.
Use of AI
AI tools were used to help understand the issue.