search

hunterloftis / newton

A playful, particle-based physics engine designed from the ground up for JavaScript.
917 stars 49 forks source link

API docs? #22

Open shakiba opened 10 years ago

shakiba commented 10 years ago

Is there any complete api doc available? I mean complete list of available classes/methods/properties?

hunterloftis commented 10 years ago

Afraid not, the originals grew out of sync with new development.

Any such docs would be greatly appreciated btw.

shakiba commented 10 years ago

Would be great to be added, without them it's almost impossible to start using it.

I'm trying to create a Newton viewer for CutJS, p2.js viewer is already created.

macu commented 10 years ago

I'm wondering whether it might be better to document the Newton source files using /**-style comments and generate the documentation from that, e.g. using YUIDoc. This would at least help keep the documentation in sync with the code. We'd have to do some research to find the best tool for extracting/rendering the docs.

hunterloftis commented 10 years ago

@macu I dig that plan. Otherwise there's just no chance that the docs keep up.

I've used this tool for that in the past: https://github.com/cbou/markdox

shakiba commented 10 years ago

You can also consider something like this, it is easy to keep updated manually and works as both manual and api-doc.