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

suggestions for improving API documentation #286

Open
tygerpatch opened this issue Sep 9, 2014 · 2 comments
Open

suggestions for improving API documentation #286

tygerpatch opened this issue Sep 9, 2014 · 2 comments

Comments

@tygerpatch
Copy link
Contributor

The API documentations haven't been updated in almost two years. It'd be nice if they were updated automatically. Also, the JsDoc Toolkit is no longer being actively developed. It is now JsDoc 3.

There is a grunt plugin for generating the documentation: https://github.com/krampstudio/grunt-jsdoc

I would also like to see a different template being used, besides Codeview. The jsdoc3Template looks nice. I think it would especially help out when you need to search for a specific method. It also displays the source code inline.

@Dakkers
Copy link

Dakkers commented Oct 9, 2014

ping @wise9

EnchantJS is probably my favourite game library for JS, and it would be nice to see its documentation updated at the very least. see #292

@rtsan
Copy link
Collaborator

rtsan commented Oct 10, 2014

Sorry to late response.
I updated API documentations show below.
http://wise9.github.io/enchant.js/doc/core/en/index.html

We will provide renewed reference using jsdoc3, but not soon. Please waiting for updating.

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

No branches or pull requests

3 participants