-
Notifications
You must be signed in to change notification settings - Fork 240
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Update Body class documentation #259
Conversation
Added information about the setType and getType methods in the Body class documentation.
This is where you need to remove |
Sure, I am on it. |
Removed `@internal` tags from getType and setType definitions.
Thanks! Api docs also needs to be added as comments in the source code, otherwise they will be overwritten by next api doc generation. If you like to see how it works you can run |
Hmm, so I could have generated the docs using that command. Just learned about that npm package. |
I reverted the docs back to its original state and edited only the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
@@ -1106,4 +1106,4 @@ ___ | |||
|
|||
*Defined in [src/dynamics/Body.ts:586](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Body.ts#L586)* | |||
|
|||
**Returns:** *void* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess this is change by mistake.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it was a mistake.
Yes, looks great! I will re-generate api docs tomorrow. There has been many small changes in the api for the new version, so I need to review them before publishing api docs. |
Added information about the setType and getType methods in the Body class documentation.