search

wise9 / enchant.js

A simple JavaScript framework for creating games and apps
http://enchantjs.com
MIT License
1.69k stars 314 forks source link

suggestions for improving API documentation #286

Open tygerpatch opened 10 years ago

tygerpatch commented 10 years ago

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 commented 10 years ago

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 commented 10 years ago

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.