docs(RenderSystem): add @param em and @returns to flushStaleMeshBuffers JSDoc#407
Merged
Merged
Conversation
2 tasks
… add matching tests Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/13b57889-c7bf-4004-a3e8-ffc596e587ec Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix JSDoc for flushStaleMeshBuffers by adding @returns tag
docs(RenderSystem): add @param em and @returns to flushStaleMeshBuffers JSDoc
Apr 2, 2026
ormidales
approved these changes
Apr 2, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates API documentation for RenderSystem.flushStaleMeshBuffers by completing its JSDoc contract and adding tests to ensure the tags remain present.
Changes:
- Added missing
@param emand@returnstags to theflushStaleMeshBuffersJSDoc block. - Added contract-style tests that assert the
@param emand@returnstags exist in the JSDoc immediately preceding the method signature.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/core/ecs/systems/RenderSystem.ts |
Completes the flushStaleMeshBuffers JSDoc by adding @param em and @returns tags. |
tests/ecs.test.ts |
Adds contract tests to prevent regression of the new JSDoc tags for flushStaleMeshBuffers. |
💡 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.
flushStaleMeshBufferswas missing@param emand@returnstags in its JSDoc block, leaving documentation generators with incomplete output and inconsistent API docs.Changes
src/core/ecs/systems/RenderSystem.ts— added@param emand@returns voidtags toflushStaleMeshBuffers, positioned before the existing@exampleblock:tests/ecs.test.ts— added two JSDoc contract tests (consistent with the repo'sreadFileSync+ substring assertion pattern) asserting that the@param emand@returnstags are present in the JSDoc block immediately preceding the method signature.