Use JSDoc for documenting SparkRenderer and SparkViewpoint options
#123
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
Contributor
|
looks great to me |
asundqui
approved these changes
Jul 15, 2025
Contributor
asundqui
left a comment
asundqui
left a comment
There was a problem hiding this comment.
Excellent, I have not used JSDoc myself in the past, I will do so going forward, thanks for starting the process!
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.
The source code documents many of the constructor options of the
SparkRendererandSparkViewpoint. However these are written using multiple single-line comments, effectively making them for internal use only. By using JSDoc the typescript compiler picks them up and retains them when emitting the type definitions. This allows users importing Spark in their projects to see this documentations in their IDE for both JS and TS projects.This PR updates the documentation comments for the
SparkRendererOptionsandSparkViewpointOptions. Ultimately more parameters, methods, classes and functions can be documented this way. If needed it can also be used to reference external resource like the online documentation of Three.js or Spark itself.Here's an example screenshot showing it in effect in VS code:
