More incremental improvements to JSDocs #7619
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This PR makes incremental improvements to the JSDocs across various modules in the codebase for enhanced clarity and better doc generation.
- Improved JSDoc tags for callbacks and class descriptions.
- Updated type annotations to better reflect possible null values.
- Enhanced typedef documentation for rendering effects.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/scene/materials/standard-material.js | Reordered callback JSDoc comment to improve docs output. |
| src/platform/sound/sound.js | Clarified audio data description in the module docs. |
| src/framework/xr/xr-manager.js | Updated callback and class docs; refined type annotation. |
| src/framework/components/sound/system.js | Improved volume property documentation. |
| src/framework/components/sound/slot.js | Expanded SoundSlot description with multi-slot detail. |
| src/framework/components/scrollbar/data.js | Updated type to include null for the handleEntity field. |
| src/extras/render-passes/camera-frame.js | Reworked typedef comments for various rendering effects. |
| src/core/tags.js | Enhanced Tags module documentation with detailed usage. |
| src/core/shape/tri.js | Added vector details to triangle description. |
willeastcott
added a commit
that referenced
this pull request
Apr 27, 2025
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.
@typedefdescriptions occur after tag to ensure they appear in the generated docs.I confirm I have read the contributing guidelines and signed the Contributor License Agreement.