Fix broken JsDoc comments #7114
Merged
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
|
🎉 Thanks for opening this pull request! Please check out our contributing guidelines if you haven't already. And be sure to add yourself to the list of contributors on the readme page! |
Member
|
Hi @Orasund, thanks. There are several formatting related changes (mostly added spaces) in this PR that is not related to the stated issue, can you please revert them? |
Contributor
Author
|
@limzykenneth Formating changes have been reverted |
Member
|
Looks good. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Background:
I want to write a p5.js Wrapper using the JSDocs for type definitions. I'm using jsdoc-to-markdown to parse the files. However, this only works if the files contain valid JsDoc annotations.
Changes:
src/color/p5.Color.js- removed duplicated@exampleannotationsrc/math/random.js- removed empty@exampleannotationsrc/webgl/material.js- removed additional]src/webgl/p5.Quat.js- removed empty@returnsannotationsrc/webgl/p5.RendererGL.Immediate.js- replacedArray[Number]withNumber[]PR Checklist
npm run lintpasses