Improve Texture JSDocs (and some others) #7595
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 improves the JSDocs for the Texture class and updates the DefaultAnimBinder documentation by removing an obsolete @implements tag.
- Enhanced descriptive documentation for textures, including clearer explanations of properties and methods.
- Corrected JSDoc terminology for compareOnRead functions and anisotropy documentation.
- Removed the outdated @implements tag from DefaultAnimBinder.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/platform/graphics/texture.js | Improved JSDocs for clarity and accuracy in method docs. |
| src/framework/anim/binder/default-anim-binder.js | Removed an unnecessary @implements tag. |
Comments suppressed due to low confidence (1)
src/platform/graphics/texture.js:1136
- The phrasing 'is called by internally by' is awkward; consider revising it to 'is called internally by'.
* is called by internally by {@link setSource} and {@link unlock}. However, it still needs to be
mvaligursky
approved these changes
Apr 24, 2025
willeastcott
changed the title
willeastcott
added a commit
that referenced
this pull request
Apr 24, 2025
* Fixes to Texture JSDocs * Tweak * More doc linking
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.
TextureJSDocs.@implementstag inDefaultAnimBinder.I confirm I have read the contributing guidelines and signed the Contributor License Agreement.