Need to Write a Doclet - Githubissues

lwhiteley / AngularLogExtender

AngularLogExtender is an AngularJS module that extends the Angular $log functionality. It uses the native $decorator to push the $log pass its capabilities and provide new functionality such as configuring the $log for different environments such as production and development

MIT License

40 stars 8 forks source link

Need to Write a Doclet #19

Closed ferronrsmith closed 10 years ago

ferronrsmith commented 10 years ago

One of the problems now is that we have a lot of documentation that is in the code. Sometimes developers don't want to read all your code to know what it is doing.

We can use grunt-jsdox to help with converting the documentation to markdown

lwhiteley commented 10 years ago

you can also look into doxx or grunt-doxx. has a better UI

ferronrsmith commented 10 years ago

we can use either doxx or jsdox. Currently doxx output is html, we would need to create a template to out the data. I prefer js-doxx because it main purpose is to output markdown.

ferronrsmith commented 10 years ago

Just looked at vision media's dox plugin, think this might be the most flexible. The templates can be built all in code.

coveralls commented 10 years ago

Changes Unknown when pulling 61d71024160621815df269772e389646b2506e57 on f/documentation into \ on develop**.

lwhiteley commented 10 years ago

should ignore the generated docs folder in the bower.json file

coveralls commented 10 years ago

Coverage remained the same when pulling 06736a2fbbc06fc608239b4d6da7f3f73c1e2a1e on f/documentation into 6871eeaec272a2c94900da06c6165eb67e1b39a9 on develop.

coveralls commented 10 years ago

Coverage remained the same when pulling f69353ed1730fa36daea36884fe7e1f4697e5685 on f/documentation into 6871eeaec272a2c94900da06c6165eb67e1b39a9 on develop.

ferronrsmith commented 10 years ago

gonna cancel this effort. duplication of #18