docs(sprite): SpriteAnimationClip name, fps, loop property JSDoc#8680
Merged
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the public API documentation for SpriteAnimationClip by adding short JSDoc summaries to existing public fields. It fits the codebase’s API-doc conventions by making user-visible sprite animation properties read clearly in generated reference docs without changing runtime behavior.
Changes:
- Added a short summary for the public
namefield. - Added a short summary for the public
fpsfield, including that negative values play backwards. - Added a short summary for the public
loopfield.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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 brief JSDoc summaries for the public
name,fps, andloopfields onSpriteAnimationClip, alongside existing@typetags. These properties are user-visible (e.g. viaSpriteComponent#addClipand playback) and surfaced in the API reference after the class-fields refactor; they should be documented as first-class API rather than@ignoreor@private.Changes
addClipparameter wording; notes that negativefpsplays backwards.Public API
Documentation only; runtime behavior unchanged.