Adding lesson 22 on ngDocs.

K.C. Hunter · K.C. Hunter · commit f7fc02cf9853 · 2015-02-03T19:24:40.000-05:00
diff --git a/GruntFile.js b/GruntFile.js
@@ -60,6 +60,10 @@ module.exports = function (grunt)
 			}
 		},
 
+		ngdocs: {
+			all: ['src/resources/js/*.js']
+		},
+
 		watch: {
 			scripts: {
 				files: ['src/resources/js/**/*.js'],
@@ -86,6 +90,7 @@ module.exports = function (grunt)
 
 	grunt.registerTask('build', 'Build the application', 
 		['sass:dev',
-		'concat:dist', 'ngAnnotate:dist', 'concat:css', 'concat:move', 'concat:map'
+		'concat:dist', 'ngAnnotate:dist', 'concat:css', 'concat:move', 'concat:map', 
+		'ngdocs'
 		]);
 }
diff --git a/package.json b/package.json
@@ -5,7 +5,8 @@
   "main": "index.js",
   "dependencies": {
     "bower": "~1.3.12",
-    "grunt-cli": "~0.1.13"
+    "grunt-cli": "~0.1.13",
+    "grunt-ngdocs": "~0.2.6"
   },
   "devDependencies": {
     "grunt-contrib-uglify": "~0.6.0",
diff --git a/src/angularjstutorial.annotated.js b/src/angularjstutorial.annotated.js
@@ -2,7 +2,7 @@
 
 var app = angular.module('MyApp', ['ngRoute'])
 
-.controller("main", ['$scope', function ($scope)
+.controller("MainCtrl", ['$scope', function ($scope)
 {
 	$scope.message = "I am an annotated message.";
 }])
diff --git a/src/angularjstutorial.js b/src/angularjstutorial.js
@@ -2,7 +2,7 @@
 
 var app = angular.module('MyApp', ['ngRoute'])
 
-.controller("main", function ($scope)
+.controller("MainCtrl", function ($scope)
 {
 	$scope.message = "I am an annotated message.";
 })
diff --git a/src/resources/js/a_app.js b/src/resources/js/a_app.js
@@ -1,3 +1,11 @@
 /* use strict */
 
+/**
+ * @ngdoc object
+ * @name MyApp
+ * @description
+ *
+ * This is the module for MyApp. It uses ngRoute.
+**/
+
 var app = angular.module('MyApp', ['ngRoute'])
diff --git a/src/resources/js/annotate.js b/src/resources/js/annotate.js
@@ -1,4 +1,37 @@
-.controller("main", function ($scope)
+/**
+ * @ngdoc controller
+ * @name MyApp.controller:MainCtrl
+ * @description
+ *
+ * This is the main controller. It creates a variable
+ * "message" on the scope and defines it with a string.
+ * <pre>
+
+ 		<div data-ng-controller="MainCtrl"></div>
+ 		
+ * </pre>
+**/
+.controller("MainCtrl", function ($scope)
 {
 	$scope.message = "I am an annotated message.";
+})
+
+/**
+ * @ngdoc directive
+ * @name MyApp.directive:maindirective
+ * @restrict A
+ * @priority 1000
+ * @description
+ *
+ * This is the main directive of the application. It
+ * is restricted to attributes and uses the 
+ * Main Controller.
+**/
+.directive("maindirective", function ()
+{
+	return {
+		restrict: 'A',
+		transclude: false,
+		controller: 'MainCtrl'
+	}
 })

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`var app = angular.module('MyApp', ['ngRoute'])`
`4`	`4`
`5`		`-.controller("main", ['$scope', function ($scope)`
	`5`	`+.controller("MainCtrl", ['$scope', function ($scope)`
`6`	`6`	`{`
`7`	`7`	`$scope.message = "I am an annotated message.";`
`8`	`8`	`}])`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`var app = angular.module('MyApp', ['ngRoute'])`
`4`	`4`
`5`		`-.controller("main", function ($scope)`
	`5`	`+.controller("MainCtrl", function ($scope)`
`6`	`6`	`{`
`7`	`7`	`$scope.message = "I am an annotated message.";`
`8`	`8`	`})`