Add tsdocs for everything and improve typings for readability #270
Conversation
This file contains 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
|
Visit the preview URL for this PR (updated for commit 204fe48): https://gcode-preview--pr270-feature-document-par-j7zk964i.web.app (expires Wed, 12 Feb 2025 22:54:51 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 59bd114ae4847b32c2bba0b68620b9069a3e3531 |
remcoder
changed the title
Comment on lines
+21
to
+27
| /** | ||
| * Creates a new BuildVolume instance | ||
| * @param x - Width in mm | ||
| * @param y - Depth in mm | ||
| * @param z - Height in mm | ||
| * @param color - Color for visualization (default: 0x888888) | ||
| */ |
There was a problem hiding this comment.
There is also an inch mode (that does not impact anything really, except some arc support calculations). It is true that it's mm by default, but not necessarily.
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.
This PR adds a lot of docs to the parser. And it reworks some types for readability. Workings remain the exactly the same.
Added tsdocs for everything. Typedoc now generates more useful documentation.