search

Vertafore / docular

AngularJS based documentation generation: Extensible, customizable parsing and partial generation
MIT License
165 stars 35 forks source link

Angular Seed Project #93

Open patorjk opened 10 years ago

patorjk commented 10 years ago

First, this is a really awesome project, so thank you for putting it together.

This is just an enhancement idea. You should consider creating an example AngularJS seed project with some example components. This way people can see what a standard AngularJS project would look like with controllers, services, directives, and filters correctly annotated.

I've found myself sort of just using trial and error to figure out how to annotate my code - basically looking at Angular's source and seeing how they do it, but tweaking it for docular. For example, my controllers have a "Usage" section that looks like this:

controller:FolderCtrl();

That seems incorrect, but I'm not sure how to get rid of it, or if I'm annotating my controllers correctly. I've also run into some other weird issues, but it's mostly just from not knowing how things should look or be setup.

I did see that you had an angular_example_docular example under your docularpres project, but it only showed services and directives.

stephenliberty commented 9 years ago

A bit late on the reply, but this is a good idea.