docs: fix JSDoc link warnings for ShaderUtils and GSplatComponent#8618
Merged
Conversation
- Correct `{@link ShaderUtils#createShader}` to `{@link ShaderUtils.createShader}` (static member uses `.`).
- Add a class-level JSDoc block to `ShaderUtils` so the class is included in the generated docs (otherwise `excludeNotDocumented` strips it and link resolution fails).
- Fix `{@link workBufferModifier}` (non-existent) to `{@link setWorkBufferModifier}` in `GSplatComponent`.
Made-with: Cursor
Made-with: Cursor
Contributor
There was a problem hiding this comment.
Pull request overview
Resolves TypeDoc {@link} resolution warnings by correcting link syntax and ensuring referenced symbols are included in generated documentation.
Changes:
- Fix
Shaderconstructor JSDoc link to the staticShaderUtils.createShaderAPI. - Add a class-level JSDoc block to
ShaderUtilsso it’s not stripped byexcludeNotDocumented: true. - Fix
GSplatComponentJSDoc link to referencesetWorkBufferModifier.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/scene/shader-lib/shader-utils.js |
Adds class-level JSDoc so ShaderUtils is documented and linkable. |
src/platform/graphics/shader.js |
Updates JSDoc link syntax for static member reference (. vs #). |
src/framework/components/gsplat/component.js |
Fixes an invalid JSDoc link target to an existing API (setWorkBufferModifier). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Made-with: Cursor
Contributor
Author
|
@mvaligursky This PR requires we make |
Contributor
|
Its useful for post effects, and some of the engine-only examples use it, so I'd say we make it public. |
Contributor
|
Yep, that function should be public. |
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
Fixes three TypeDoc
{@link}resolution warnings surfaced bynpm run docs:src/platform/graphics/shader.js- change{@link ShaderUtils#createShader}to{@link ShaderUtils.createShader}(static members use.).src/scene/shader-lib/shader-utils.js- add a class-level JSDoc block toShaderUtils. Without it,excludeNotDocumented: truestrips the class from the generated docs, which is why the link above failed to resolve even after the syntax fix.src/framework/components/gsplat/component.js- change{@link workBufferModifier}(no such symbol) to{@link setWorkBufferModifier}.Test plan
npm run docs- the three targeted warnings are gone.ShaderUtilspage andShaderconstructor docs to confirm the link now resolves.