How to generate documentation using ngdoc?

[selvam Palanimalai]

Hi guys,

I am new to angular world.
I was wondering is there a way to use the ngdoc (or doc parser used by angularJS) to generate documentation from the comments in the source code for the app that I am building using angularJS. Where can I find the syntax to be used to in the comments so that ngdoc is able to parse it? 

[Sam Pepose]

Look at the Angular source: https://github.com/angular/angular.js/blob/master/src/Angular.js

Look at this discussion: https://groups.google.com/forum/?fromgroups=#!topic/angular/tUh1yr56WPY

[selvam Palanimalai]

Hi Sam,

Thanks for the reply, I did look at the angular source link that you mentioned and I can get some idea on what would be the syntax for writing comments. But how to generate the documentation out of the code?
How do  initiate the process of document generation? Is there a node package or something which I need to install? Or the document is generated when the application bootstraps? 

Thanks!

[Sam Pepose]

Take a look at the src for their docs: https://github.com/angular/angular.js/tree/master/docs/src

They have a Nodejs script to make their documentation. You'll have to find someone else to help with more detailed of an explanation because I've never used this before, but hopefully I've given a good enough starting point.

--
You received this message because you are subscribed to a topic in the Google Groups "AngularJS" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/angular/mYKs0ZCaB6o/unsubscribe?hl=en-US.
To unsubscribe from this group and all its topics, send an email to angular+u...@googlegroups.com.
To post to this group, send email to ang...@googlegroups.com.
Visit this group at http://groups.google.com/group/angular?hl=en-US.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

--

Sam Pepose

Developer

Oasis Digital Solutions Inc.

http://oasisdigital.com/