ng-doc basic setup

Author: StyleT

.gitignore

@@ -1,3 +1,6 @@
+# master only
+/docs
+
 # Created by https://www.gitignore.io
 
 ### Project ###

gulpfile.js

@@ -10,7 +10,6 @@ var path = require('path');
 var cache = require('gulp-cache');
 var angularFilesort = require('gulp-angular-filesort');
 var ngAnnotate = require('gulp-ng-annotate');
-var karmaServer = require('karma').Server;
 
 // Check for "TRUE" code style in JS files
 gulp.task('lint', function () {
@@ -51,12 +50,23 @@ gulp.task('compile', function () {
 });
 
 gulp.task('test', ['lint', 'compile'], function (done) {
+    var karmaServer = require('karma').Server;
+
     new karmaServer({
         configFile: __dirname + '/karma.conf.js',
         browsers: ['PhantomJS']
     }, done).start();
 });
 
+gulp.task('generate-doc', function () {
+    var gulpDocs = require('gulp-ngdocs');
+    return gulp.src('./src/**/*.js')
+        .pipe(gulpDocs.process({
+            html5Mode: false
+        }))
+        .pipe(gulp.dest('./docs'));
+});
+
 
 gulp.task('watch', function () {
     gulp.watch(['./lib/**/*.js'], ['lint', 'compile']);

package.json

@@ -32,6 +32,7 @@
     "gulp-concat": "~2.6.0",
     "gulp-jshint": "~1.11.2",
     "gulp-ng-annotate": "^1.0.0",
+    "gulp-ngdocs": "^0.2.13",
     "jasmine-core": "^2.3.4",
     "karma": "^0.13.9",
     "karma-chrome-launcher": "^0.2.0",

src/acl-registry-service.js

@@ -1,13 +1,13 @@
 /**
- * @ngdoc service
- * @name AclRegistryService
+ * @ngdoc object
+ * @name ng-acl.AclRegistryService
  * @description AclRegistryService factory
  */
 angular.module('ng-acl').factory('AclRegistryService', function () {
     'use strict';
 
     /**
-     * @ngdoc method
+     * @name AclRegistryService
      * @constructs AclRegistryService
      * @description Initializes a new ACL role registry
      */

src/acl-service.js

@@ -37,8 +37,8 @@
 
 
 /**
- * @ngdoc service
- * @name AclService
+ * @ngdoc object
+ * @name ng-acl.AclService
  * @description
  *    Provides a lightweight and flexible access control list (ACL) implementation for privileges management.
  *    In general, an application may utilize such ACL‘s to control access to certain protected objects by other requesting objects.

src/acl.js

@@ -1 +1,9 @@
+/**
+ * @ngdoc overview
+ * @name ng-acl
+ *
+ * @description
+ * # ng-acl
+ * Angular ACL module
+ */
 angular.module('ng-acl', []);