Docs: More JSDoc. #30733
Merged
Docs: More JSDoc. #30733
Conversation
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
Owner
|
Really really amazing work! 🙏🙏🙏 |
Contributor
|
well done and thank you 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Related issue: -
Description
Moves
examples/jsm/shadersto JSDoc. I just moved the existing comments to JSDoc but without documenting all the possible uniforms. This is currently out-of-scope for me. I'm okay with doing this for new TSL shaders but not for the code inexamples/jsm/shaders. If someone else wants to do this, I'm happy to review and support PRs as good as possible.With this PR,
examples/jsmis completely migrated to JSDoc and I'm so glad this is over^^. Adding JSDoc to the core and addons was one of the most time consuming tasks I've done for this project.