Add documentation with Typedoc again

[marcofugaro]

Close #12

This PR is a continuation of #14, it uses the newer beta of Typedoc being developed in TypeStrong/typedoc#1364.

Preview of the docs here

Things to fix

• Show the class params in the class page.

Currently the class params are not being shown,

this is probably because the JSDoc @param definition is not supported in Typedoc

However they are being shown in the homepage, which is not the correct place for them

I guess this is because the type BodyOptions is exported directly?

• Class properties and methods comments are not shown

This is because the comment are currently in line format:

They need to be in JSDoc format:

UI/UX Improvements

• Disable the header scroll-up behaviour, it is annoying
• Hide the All and Only exported keys, we don't use them in this project

[stockhuman]

Hey @marcofugaro, I can help out with this in my spare time, and push AABB unless you had other plans. :)

[marcofugaro]

❤️❤️
thanks @stockhuman any help is appreciated, commits 8cf2711#diff-a0a9650986b438fd092671e05a98fb560e381188460824affdf3a41a97bef0f0 and b1ff14a should help you get started.

Basically here is what you do:

• convert // comments to /** comments for class properties
• put static methods/properties in the class
• remove any @method jsdoc annotation in the class methods
• remove every jsdoc annotation except @example in the class jsdoc comment
• move the options type in the constructor and export the type like this export type SpringOptions = ConstructorParameters<typeof Spring>[2]

In the meantime I was working on updating the examples to three 0.125 and researching a better way of doing the BufferGeometry to ConvexGeometry conversion in the branch three-update

[stockhuman]

@marcofugaro Yeah - I saw b1ff14a - it's very helpful. :)

I completely missed the r125 branch; I guess the pull to fix use-cannon can wait on whatever we settle on as I quite like being able to simply pass geometries to convexPolyhedron.

[marcofugaro]

🤩 amazing work @stockhuman thanks a lot!

Just an issue, could you leave out of this PR the stuff non related to JSDoc? Such as using an inline Vec3 here. I believe the Vec3 is saved outside of the class for memory reasons.

This is the diff of the stuff you did, if it's useful b1ff14a...pmndrs:0b81356

[stockhuman]

I'm getting this.emitContactEvents is not a function in the examples, coming from within World. This seems to predate my changes (present in b1ff14a), but working as intended by ac7a1f2.

[stockhuman]

Just an issue, could you leave out of this PR the stuff non related to JSDoc? Such as using an inline Vec3 here. I believe the Vec3 is saved outside of the class for memory reasons.

Sure thing, will undo. :)

[marcofugaro]

Little typo at line 37 of RaycastVehicle.ts

[marcofugaro]

I'm getting this.emitContactEvents is not a function in the examples, coming from within World. This seems to predate my changes (present in b1ff14a), but working as intended by ac7a1f2.

Ummm, will look into this

[stockhuman]

Little typo at line 37 of RaycastVehicle.ts

Embarrassing, lol.

[marcofugaro]

Thanks for the amazing work @stockhuman!! I'll take it from here, fix the build issue and solve conflicts in next few days.

[stockhuman]

Awesome, glad I could help. :)

[marcofugaro]

The documentation is done! 🎉

Preview: https://raw.githack.com/pmndrs/cannon-es/typedoc2/docs/index.html

Ended up enabling the excludeNotDocumented option to hide all internal stuff, but that meant adding a jsdoc comment to all methods that need to be exposed. It is done!

Only thing to fix is the build issue, it's pretty straightforward, will fix it soon.