Skip to content
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

Merged
merged 5 commits into from
Aug 20, 2023
Merged

docs: Update Body class documentation #259

merged 5 commits into from
Aug 20, 2023

Conversation

hbaklan943
Copy link
Contributor

Added information about the setType and getType methods in the Body class documentation.

Added information about the setType and getType methods in the Body class documentation.
@shakiba
Copy link
Collaborator

shakiba commented Aug 20, 2023

This is where you need to remove @internal tag if you would like:
https://github.com/piqnt/planck.js/blob/master/src/dynamics/Body.ts#L388

@hbaklan943
Copy link
Contributor Author

Sure, I am on it.

Removed `@internal` tags from getType and setType definitions.
@shakiba
Copy link
Collaborator

shakiba commented Aug 20, 2023

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 npm run typedoc. But please do not add generated docs in this PR, I will generate them a little bit later.

@hbaklan943
Copy link
Contributor Author

hbaklan943 commented Aug 20, 2023

Hmm, so I could have generated the docs using that command. Just learned about that npm package.
Now editing the source code accordingly...

@hbaklan943
Copy link
Contributor Author

hbaklan943 commented Aug 20, 2023

I reverted the docs back to its original state and edited only the src/dynamics/Body.ts to add doc comment to method definitions, hopefully, that was what you wanted.

Copy link
Collaborator

@shakiba shakiba left a 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*
Copy link
Collaborator

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.

Copy link
Contributor Author

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.

@shakiba
Copy link
Collaborator

shakiba commented Aug 20, 2023

I reverted the docs back to its original state and edited only the src/dynamics/Body.ts to add doc comment to method definitions, hopefully, that was what you wanted.

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.

@shakiba shakiba merged commit a69b204 into piqnt:master Aug 20, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants