JsDoc sample app

This is just demo app, how we can add jsdoc in our nodejs app or any javascript projects like Appcelerator Titnaium, Cordova PhoneGap, AngularJs...

Fresh setup

1. npm init //fill all the questions need to setup new project

2. Add jsDoc and docstrap

   • npm install --save-dev jsdoc
   • npm install --save-dev ink-docstrap

3. Add comments in javascript code (please flow format http://usejsdoc.org/)

4. Add "jsdocs":"jsdoc -c jsdocConfig.json src -t ./node_modules/ink-docstrap/template -R README.md -r -d docs" under scripts in package.json

5. Once done with comments, just npm run jsdocs from root folder

6. In root folder it will create new folder called docs. Open index.html and see.

Download & Run this code

1. Just run below command from project root folder
   • npm install
   • or npm update

2. Just npm run jsdocs from root folder

3. In root folder it will create new folder called docs. Open index.html and see.

Reference links

http://usejsdoc.org/about-commandline.html

https://github.com/docstrap/docstrap#configuring-the-template

http://usejsdoc.org/

http://typedoc.org/guides/installation/