Upgrade the documentation processor to last JSDoc 3 version

from :
http://code.google.com/p/jsdoc-toolkit/

to :
https://github.com/jsdoc3/jsdoc

[obiot]

jsdoc3 documentation (for reference)
http://usejsdoc.org/

[obiot]

@DblK

Hi, grunt is in place (see #167) together with Jsdoc3, did you make any progress on your side on the template ?
On my side I just fixed a few typo/mistakes in the current source, just got jsdoc3 to generate the html content, and the big next step IS actually the template :)

[DblK]

I'll submit a patch when I'll finish what I'm doing now. I update the makefile and also the tools.

[obiot]

@DblK that's great !
note that we changed the build system to use grunt now, so :

• the makefile does not exist anymore and has been resplace by Gruntfile.js
• jsdoc has been updated in the process and we do now use jsdo3
• doc can be generated using the grunt doc

so if you submit a patch be sure to refresh your repository first (as a pull request with the previous makefile will fail), or you can send us a zip version of the template per email (contact@melonjs.org)

[parasyte]

Reposting here!

Replace jsdoc with dox? https://github.com/punkave/grunt-dox

[obiot]

oh, I never heard about this one!
what about the meta data ? my only concern so far is for all the comment to be (completely this time) rewritten :)

[parasyte]

I'm not sure! The only thing I know about grunt-dox is no jsdoc (no Java)!

[parasyte]

@obiot ⚠️ Last ticket on 0.9.7 milestone! 😃

[obiot]

Wow yes! And not the most easy one :)

I'll have a look at dox tonight and try to evaluate what is the short term easiest solution (compared to jsdoc)
Honestly I almost got all main differences in terms of tagging (I need one night to go through all the source code and update it accordingly), the most difficult part for me being on the HTML/CSS template, since this is not at all a part where I am good st (I dont't know if you can help on that?)

By he way there is as well a markdown plugin for jsdoc, that would be great to generate "GitHub" pages for the API! But I guess it's maybe another improvements for 0.9.8 :)

[parasyte]

re: markdown plugin ... interesting find. It could be useful for automatically generating README.md files, but I also don't want to "clutter" the repo with automated changes.

BTW, this is the actual parser used by grunt-dox: https://github.com/visionmedia/dox It looks like it just uses jsdoc-style comments and spits out JSON. Then dox-foundation puts that JSON through the template engine (Foundation) to generate the HTML documentation. That's my understanding, anyway.

And yeah, I can help with some of the HTML/CSS part.