Skip to content

refactor: Remove unused JSDoc @import lines from sound and rigid-body components#8920

Merged
willeastcott merged 1 commit into
playcanvas:mainfrom
mmjinglin163:docs-fix
Jun 18, 2026
Merged

refactor: Remove unused JSDoc @import lines from sound and rigid-body components#8920
willeastcott merged 1 commit into
playcanvas:mainfrom
mmjinglin163:docs-fix

Conversation

@mmjinglin163

Copy link
Copy Markdown
Contributor

Description

Removes unused JSDoc @import type-only lines that are not referenced in the file:

SoundComponent — Entity
RigidBodyComponent — Entity
These imports were only referenced via @link in documentation and not in type annotations (@type, @param, @returns). No runtime behavior changes.

Following the pattern established in #8677.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Removes unused JSDoc @import type-only declarations for Entity from two framework component modules, aligning with the cleanup approach used in #8677 and keeping type-only imports limited to symbols referenced in actual JSDoc type annotations.

Changes:

  • Removed unused JSDoc @import { Entity } from SoundComponent docs header.
  • Removed unused JSDoc @import { Entity } block from RigidBodyComponent.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/framework/components/sound/component.js Drops unused @import { Entity } while retaining the needed SoundInstance type import.
src/framework/components/rigid-body/component.js Removes an unused Entity-only JSDoc import block (Entity remains referenced only via {@link ...} in docs).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@willeastcott

Copy link
Copy Markdown
Contributor

Well spotted, @mmjinglin163! How did you find these? Intellisense didn't highlight them.

@willeastcott willeastcott merged commit d47e281 into playcanvas:main Jun 18, 2026
7 of 9 checks passed
@mmjinglin163

Copy link
Copy Markdown
Contributor Author

I discovered through cursor analysis in the engineering project

@mmjinglin163 mmjinglin163 deleted the docs-fix branch June 18, 2026 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants