feat(gen) add grunt-ngdoc #551
Conversation
|
How does this play with the CoffeeScript versions of the files? What about when/if TypeScript is added? |
|
Definitely should be supported as well. If there is a way to write comments in coffee/typeScript and have them preserved after compilation this should be easy to accomplished on generator part. |
|
Example documentation is served on the github page. Suggestions to wording are welcome. |
|
For jsdoc in coffee I try something like here. For typescript there is less resources, but comments syntax seems to be quite similar to js. |
|
I was able to get this working with typescript with a couple changes. I just copied the docs from the js templates to the ts templates. I also had to modify the ngdoc task to include the path of the generated js files (this would also need to be done for coffeescript) see: https://github.com/eggers/generator-angular/tree/ngdocs |
|
Thanks, @marcin-wosinek I just made the one change I proposed. |
| 'partials/{,*/}*.html', | ||
| 'css/*.css', | ||
| 'js/*.js', | ||
| 'js/*.js', |
|
+1 please do merge! |
|
Haven't forget about this but need to do some more testing and other things first |
|
Can you split this into two PRs? One that has all the comments/docs and the other for the Gruntfile? For the comments, can you also add the same things to the CS fileS? |
|
ping @marcin-wosinek |
Add jsdoc to generated text and add grunt-ngdocs generated documentation to /docs. Add grunt-ngdocs to package.json & Gruntfile.js. Basic support in js & coffee templates. Watch for changes in files & autoreload docs after regeneration. Init work at yeoman#550
|
Ok rebased & splited. |
Add jsdoc to generated text and add grunt-ngdocs generated documentation
to /docs.
Add grunt-ngdocs to package.json & Gruntfile.js. Basic support in js templates.
Watch for changes in js files & autoreload docs after regeneration.
Init work at #550
Example:
