From: Gustavo Martin Morcuende <gu.martinm@gmail.com>
Date: Fri, 21 Aug 2015 16:32:44 +0000 (+0200)
Subject: showcase: ngdoc improvements
X-Git-Url: https://git.gumartinm.name/?a=commitdiff_plain;h=ffffae2fc3e9a9161b567d94257f6de130b5741a;p=JavaScriptForFun

showcase: ngdoc improvements
---

diff --git a/angularjs/showcase/src/showcase/app/app.module.js b/angularjs/showcase/src/showcase/app/app.module.js
index 3f303a5..4e68a30 100644
--- a/angularjs/showcase/src/showcase/app/app.module.js
+++ b/angularjs/showcase/src/showcase/app/app.module.js
@@ -2,6 +2,19 @@
 
   'use strict';
 
+  /**
+   * @ngdoc overview
+   * @name app
+   *
+   * @requires app.core
+   * @requires app.welcome
+   *
+   * @description
+   * # app
+   *
+   * ## Main module for the current application
+   * There are several sub-modules included with the app module.
+   */
   angular.module('app', [
     /* Shared modules */
     'app.core',
diff --git a/angularjs/showcase/src/showcase/app/core/core.module.js b/angularjs/showcase/src/showcase/app/core/core.module.js
index d4e3985..5a15d2b 100644
--- a/angularjs/showcase/src/showcase/app/core/core.module.js
+++ b/angularjs/showcase/src/showcase/app/core/core.module.js
@@ -1,6 +1,20 @@
 (function() {
   'use strict';
 
+  /**
+   * @ngdoc overview
+   * @name app.core
+   *
+   * @requires ui.router
+   * @requires ui.bootstrap
+   * @requires ui.bootstrap.modal
+   *
+   * @description
+   * # app.core
+   *
+   * ## core module for the current application
+   * Shared modules across the whole application will be located in the app.core module.
+   */
   angular.module('app.core', [
     /* 3rd-party modules */
     'ui.router',
diff --git a/angularjs/showcase/src/showcase/app/welcome/welcome.controller.js b/angularjs/showcase/src/showcase/app/welcome/welcome.controller.js
index 41ee92f..c4651cf 100644
--- a/angularjs/showcase/src/showcase/app/welcome/welcome.controller.js
+++ b/angularjs/showcase/src/showcase/app/welcome/welcome.controller.js
@@ -10,6 +10,15 @@
   // Instead I am going to use ngInject because it is cool :)
   // Welcome.$inject = ['$location'];
 
+  /**
+   * @ngdoc object
+   * @name app.welcome.$Welcome
+   *
+   * @requires $location
+   *
+   * @description
+   * Welcome controller.
+   */
   /* @ngInject */
   function Welcome($location) {
     var vm = this;
diff --git a/angularjs/showcase/src/showcase/app/welcome/welcome.module.js b/angularjs/showcase/src/showcase/app/welcome/welcome.module.js
index 31702c1..f9986a3 100644
--- a/angularjs/showcase/src/showcase/app/welcome/welcome.module.js
+++ b/angularjs/showcase/src/showcase/app/welcome/welcome.module.js
@@ -1,6 +1,19 @@
 (function() {
   'use strict';
 
+  /**
+   * @ngdoc overview
+   * @name ui.router.util
+   *
+   * @requires app.core
+   *
+   * @description
+   * # app.welcome
+   *
+   * ## Module welcome.
+   * Module in charge of displaying a nice welcome page.
+   *
+   */
   angular.module('app.welcome', [
     'app.core'
   ]);