aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorMatias Niemelä2013-10-16 22:48:32 -0400
committerMatias Niemelä2013-10-23 17:00:12 -0400
commita7e12b7959212f2fa88fe17d5a045cc9d8b22922 (patch)
tree3613ad9f20a92eb9e7a88402e34a078092663cba /src
parent3f568b22f9bec09192588e3cae937db5c2e757f9 (diff)
downloadangular.js-a7e12b7959212f2fa88fe17d5a045cc9d8b22922.tar.bz2
feat(docs): provide index pages for each angular module
Diffstat (limited to 'src')
-rw-r--r--src/ngAnimate/animate.js4
-rw-r--r--src/ngCookies/cookies.js5
-rw-r--r--src/ngMock/angular-mocks.js12
-rw-r--r--src/ngResource/resource.js6
-rw-r--r--src/ngRoute/route.js3
-rw-r--r--src/ngSanitize/sanitize.js2
-rw-r--r--src/ngTouch/touch.js9
7 files changed, 28 insertions, 13 deletions
diff --git a/src/ngAnimate/animate.js b/src/ngAnimate/animate.js
index 35c52a6f..3c9ea9a9 100644
--- a/src/ngAnimate/animate.js
+++ b/src/ngAnimate/animate.js
@@ -8,10 +8,12 @@
*
* # ngAnimate
*
- * `ngAnimate` is an optional module that provides CSS and JavaScript animation hooks.
+ * The `ngAnimate` module provides support for JavaScript and CSS3 animation hooks within core and custom directives.
*
* {@installModule animate}
*
+ * <div doc-module-components="ngAnimate"></div>
+ *
* # Usage
*
* To see animations in action, all that is required is to define the appropriate CSS classes
diff --git a/src/ngCookies/cookies.js b/src/ngCookies/cookies.js
index 206e8708..94964bf8 100644
--- a/src/ngCookies/cookies.js
+++ b/src/ngCookies/cookies.js
@@ -7,11 +7,12 @@
*
* # ngCookies
*
- * Provides the {@link ngCookies.$cookies `$cookies`} and
- * {@link ngCookies.$cookieStore `$cookieStore`} services.
+ * The `ngCookies` module provides a convenient wrapper for reading and writing browser cookies.
*
* {@installModule cookies}
*
+ * <div doc-module-components="ngCookies"></div>
+ *
* See {@link ngCookies.$cookies `$cookies`} and
* {@link ngCookies.$cookieStore `$cookieStore`} for usage.
*/
diff --git a/src/ngMock/angular-mocks.js b/src/ngMock/angular-mocks.js
index 703fbe34..c832562a 100644
--- a/src/ngMock/angular-mocks.js
+++ b/src/ngMock/angular-mocks.js
@@ -1708,8 +1708,16 @@ angular.mock.$RootElementProvider = function() {
* @name ngMock
* @description
*
- * The `ngMock` is an angular module which is used with `ng` module and adds unit-test configuration
- * as well as useful mocks to the {@link AUTO.$injector $injector}.
+ * # ngMock
+ *
+ * The `ngMock` module providers support to inject and mock Angular services into unit tests. In addition,
+ * ngMock also extends various core ng services such that they can be inspected and controlled in a synchronous
+ * manner within test code.
+ *
+ * {@installModule mocks}
+ *
+ * <div doc-module-components="ngMock"></div>
+ *
*/
angular.module('ngMock', ['ng']).provider({
$browser: angular.mock.$BrowserProvider,
diff --git a/src/ngResource/resource.js b/src/ngResource/resource.js
index 3b23bbb9..968e81f5 100644
--- a/src/ngResource/resource.js
+++ b/src/ngResource/resource.js
@@ -9,12 +9,12 @@ var $resourceMinErr = angular.$$minErr('$resource');
*
* # ngResource
*
- * `ngResource` is the name of the optional Angular module that adds support for interacting with
- * [RESTful](http://en.wikipedia.org/wiki/Representational_State_Transfer) server-side data sources.
- * `ngResource` provides the {@link ngResource.$resource `$resource`} service.
+ * The `ngResource` module provides interaction support with RESTful services via the $resource service.
*
* {@installModule resource}
*
+ * <div doc-module-components="ngResource"></div>
+ *
* See {@link ngResource.$resource `$resource`} for usage.
*/
diff --git a/src/ngRoute/route.js b/src/ngRoute/route.js
index 060e2208..21459aab 100644
--- a/src/ngRoute/route.js
+++ b/src/ngRoute/route.js
@@ -11,6 +11,7 @@
*
* {@installModule route}
*
+ * <div doc-module-components="ngRoute"></div>
*/
/* global -ngRouteModule */
var ngRouteModule = angular.module('ngRoute', ['ng']).
@@ -581,4 +582,4 @@ function $RouteProvider(){
return result.join('');
}
}];
-} \ No newline at end of file
+}
diff --git a/src/ngSanitize/sanitize.js b/src/ngSanitize/sanitize.js
index b9381ea2..7bd9aae3 100644
--- a/src/ngSanitize/sanitize.js
+++ b/src/ngSanitize/sanitize.js
@@ -13,6 +13,8 @@ var $sanitizeMinErr = angular.$$minErr('$sanitize');
*
* {@installModule sanitize}
*
+ * <div doc-module-components="ngSanitize"></div>
+ *
* See {@link ngSanitize.$sanitize `$sanitize`} for usage.
*/
diff --git a/src/ngTouch/touch.js b/src/ngTouch/touch.js
index e785d82e..17dad196 100644
--- a/src/ngTouch/touch.js
+++ b/src/ngTouch/touch.js
@@ -7,14 +7,15 @@
*
* # ngTouch
*
- * `ngTouch` is the name of the optional Angular module that provides touch events and other
- * helpers for touch-enabled devices.
- * The implementation is based on jQuery Mobile touch event handling
- * ([jquerymobile.com](http://jquerymobile.com/))
+ * The `ngTouch` module provides touch events and other helpers for touch-enabled devices.
+ * The implementation is based on jQuery Mobile touch event handling ([jquerymobile.com](http://jquerymobile.com/)).
*
* {@installModule touch}
*
* See {@link ngTouch.$swipe `$swipe`} for usage.
+ *
+ * <div doc-module-components="ngTouch"></div>
+ *
*/
// define ngTouch module