ng-docsAngularjs documentation

Why Documentation?

●Everything is clearly explained

●Any body can work on other's code

●Helpful in proper communication

How to run ng-docs

Step 1

Installgrunt-ngdocsnpm install grunt-ngdocs --save-dev

orgulp-ngdocsnpm install gulp-ngdocs --save-dev

Step 2

Add annotations/*** @ngdoc* @name* @restrict* @element* @scope*/

Step 3

Run● Gruntfile.jsngdocs: { all: ['src/**/*.js']}

● Gulpfile.js● gulp.task('ngdocs', [], function () {● var gulpDocs = require('gulp-ngdocs');● return gulp.src('path/to/src/*.js')● .pipe(gulpDocs.process())● .pipe(gulp.dest('./docs'));});

Controller

/*** @ngdoc controller* @name user.controller:measurementsController* @description* @requires $scope* @requires dignio.service:chartServices**/

Directive

/*** @ngdoc directive * @name dignio.directive:pidValidation* @restrict EA* @description* @requires userService* @requires toastr* @example*/

Service/*** @ngdoc service* @name dignio.service:auth* @description**/

Method

/*** @ngdoc method* @name formatData* @methodOf dignio.service:chartServices* @description* @param {string} Type of graph* @param {Array} Device measurement list* @returns {Array} Array of objects.*/

Demo gulp-ngdocs

Thank you...

References…