Initial JSDoc #41
Open
Initial JSDoc #41
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
Added basic JSDoc that covers most public/protected methods and exports. This commit is intended more as a draft which should first be checked for inconsistencies.
Removed all inconsistent ID usages and old information
|
If this PR is still not ready for merging or review, please convert it into a draft. |
|
I've checked over the documentation and I believe that no changes will be necessary after all (or at least I didn't find any) so I'll mark the draft as a normal PR now. |
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.
Adds initial JSDoc. This PR is meant more as an initial draft and is expected to receive more commits which will address inconsistent/incorrect documentation before merging into the base repository.