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

Change to JSDoc #210

Closed
ivmartel opened this issue Mar 3, 2016 · 0 comments
Closed

Change to JSDoc #210

ivmartel opened this issue Mar 3, 2016 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@ivmartel
Copy link
Owner

ivmartel commented Mar 3, 2016

YUIDoc processes the comment blocks to create documentation which means you need to tell him the name of the classes/methods/functions. This is error prone. JSDoc parses the code to get the names which is much more powerful. It also means that lees documentation comments are needed.
A grunt plugin, grunt-jsdoc is available.
A first transition will consist in removing all the (at)method, property, class (and associated namespace) and modules.

@ivmartel ivmartel added the enhancement New feature or request label Mar 3, 2016
@ivmartel ivmartel added this to the 0.14.0 milestone Mar 3, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant