JSDoc: make sure only user-facing entities are included in the docs, and add TS support #1923
Conversation
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
larabr
force-pushed
the
jsdoc-better-docs
branch
2 times, most recently
from
140e36b to
bfb8c51
Compare
larabr
force-pushed
the
jsdoc-better-docs
branch
from
bfb8c51 to
db9f5be
Compare
twiss
approved these changes
Nov 5, 2025
To reference types
To make sure only user-facing entities are included in the docs, since access is public by default. NB: the top-level access directive seems to work to hide index entrypoint files, but in other cases (e.g. s2k submodules), exported functions may need to manually be marked as private. Also, the 'initialCommentsOnly' rule sometimes reports false positives in case of multiple comment blocks separated by new lines. The solution is to remove the new lines.
larabr
force-pushed
the
jsdoc-better-docs
branch
from
db9f5be to
d88b842
Compare
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.
Some exported entities were not visible in the docs since TS modules were not parsed,
while some internal functions were wrongly included (e.g. fix #1837) .
See commits for more details.