docs: fix more incorrect JSDoc in public APIs#8613
Merged
Conversation
Made-with: Cursor
Contributor
There was a problem hiding this comment.
Pull request overview
Docs-only follow-up that corrects objectively wrong JSDoc/comment text across multiple public APIs and shader-source comment blocks, improving generated documentation accuracy without affecting runtime behavior.
Changes:
- Fixes multiple duplicated-word typos in JSDoc and shader comments across the engine.
- Corrects broken
{@link ...}references inRotateGizmodeprecation docs. - Clarifies documentation for
MeshInstance#getParameterto include theundefinedcase, matching actual behavior.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/core/math/mat4.js | Fixes duplicate-word typo in Mat4 documentation. |
| src/framework/bundle/bundle.js | Fixes duplicate-word typo in Bundle internal index doc. |
| src/framework/components/layout-group/component.js | Fixes duplicate-word typo in wrap/wrapping JSDoc. |
| src/framework/components/rigid-body/component.js | Fixes missing word (“from”) in applyForce overload docs. |
| src/framework/xr/xr-anchor.js | Fixes duplicate-word typo in public @event description. |
| src/extras/gizmo/rotate-gizmo.js | Fixes broken {@link} reference in deprecated orbitRotation docs. |
| src/platform/graphics/dynamic-buffers.js | Fixes duplicate-word typo in staging→GPU copy description. |
| src/platform/graphics/texture.js | Fixes duplicate-word typo in WebGL2 renderability note. |
| src/platform/graphics/uniform-buffer-format.js | Fixes duplicate-word typo in UniformBufferFormat descriptor doc. |
| src/platform/graphics/webgpu/webgpu-dynamic-buffers.js | Fixes duplicate-word typo in staging-buffer lifecycle comment. |
| src/scene/graphics/post-effect.js | Fixes duplicate-word typo in PostEffect class description. |
| src/scene/materials/standard-material.js | Fixes duplicate-word typos in refraction/thickness vertex color docs. |
| src/scene/mesh-instance.js | Updates getParameter return docs to include undefined when missing. |
| src/scene/shader-lib/programs/standard.js | Fixes duplicate-word typo in shader generator JSDoc. |
| src/scene/shader-lib/glsl/chunks/render-pass/frag/sampleCatmullRom.js | Fixes duplicate-word typo in GLSL shader-source comment. |
| src/scene/shader-lib/wgsl/chunks/render-pass/frag/sampleCatmullRom.js | Fixes duplicate-word typo in WGSL shader-source comment. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Made-with: Cursor
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 16 out of 16 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Apr 19, 2026
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
Follow-up to #8612. Another docs-only pass fixing objectively-wrong JSDoc and comment issues across the engine. No runtime behaviour changes.
Duplicate-word typos (14 sites)
Each is a one-word fix inside a JSDoc or shader-source comment line:
src/core/math/mat4.js— "the the matrix"src/framework/bundle/bundle.js— "to to DataView"src/framework/components/layout-group/component.js— "will be be rendered"src/framework/xr/xr-anchor.js— "has has been persisted" (public@event)src/platform/graphics/dynamic-buffers.js— "staging to to the GPU buffer"src/platform/graphics/texture.js— "3 formats formats"src/platform/graphics/uniform-buffer-format.js— "layout of of data"src/platform/graphics/webgpu/webgpu-dynamic-buffers.js— "in the the command buffer"src/scene/graphics/post-effect.js— "take a a render target"src/scene/materials/standard-material.js(x2) — "will be be multiplied" onrefractionVertexColorandthicknessVertexColorpropssrc/scene/shader-lib/programs/standard.js— "to to replace"src/scene/shader-lib/glsl/chunks/render-pass/frag/sampleCatmullRom.jsand its WGSL twin — "sample a a 4x4 grid" in shader source commentsBroken
{@link}cross-referencesrc/extras/gizmo/rotate-gizmo.js(2 sites) —@deprecated Use {@link RotationGizmo#rotationMode}. The class isRotateGizmo;RotationGizmodoes not exist anywhere insrc/. Fixed to{@link RotateGizmo#rotationMode}.Missing word in
applyForcedescriptionsrc/framework/components/rigid-body/component.js(2 overload blocks) — "the force can be applied at an offset this point..." -> "...at an offset from this point...".Incomplete
@returnstypesrc/scene/mesh-instance.js—MeshInstance#getParameterreturnsthis.parameters[name], which isundefinedwhen the key is missing. Documented@returns {object}->@returns {object|undefined}with a matching description. This mirrors theCompute#getParameterfix already merged in docs: fix incorrect JSDoc in public APIs #8612.Public API changes
Only JSDoc changes; no runtime signatures change. One documented return type is widened:
Before:
After:
Test plan
npx eslinton all 16 touched files passes.