dotJEM / angular-routing

Enhanced state based routing for Angular applications!
https://dotjem.github.io/angular-routing/
MIT License
75 stars 9 forks source link

Tasks for writing API Docs and a better template for it. #17

Closed jeme closed 11 years ago

jeme commented 11 years ago

Currently there isn't allot of documentation in form of API docs.

But the code is getting so comprehensive that I think ill have to do a number of tasks to cover each area that needs to be documented.

This tasks is here to ensure that I get around to define all those tasks at some point, so I can take the documentation incrementally (bit by bit)

Also, after AngularJS switched to grunt as well, ng-doc generation might be feasible to swtich over to, will only do that if it does enhance the documentation, otherwise YUIDoc is fine.

jeme commented 11 years ago

That is all for now, need to remember to add tasks for individual new providers and services, besides, just defaulted to add the "pairs" for all the above, although some providers currently doesn't have any function other than creating the service.