-
Notifications
You must be signed in to change notification settings - Fork 49
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
API docs? #22
Comments
Afraid not, the originals grew out of sync with new development. Any such docs would be greatly appreciated btw. |
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. |
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. |
@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 |
You can also consider something like this, it is easy to keep updated manually and works as both manual and api-doc. |
Is there any complete api doc available? I mean complete list of available classes/methods/properties?
The text was updated successfully, but these errors were encountered: