feat(docs): provide index pages for each angular module

This commit is contained in:
Matias Niemelä
2013-10-16 22:48:32 -04:00
parent 3f568b22f9
commit a7e12b7959
13 changed files with 400 additions and 18 deletions

View File

@@ -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

View File

@@ -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.
*/

View File

@@ -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,

View File

@@ -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.
*/

View File

@@ -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('');
}
}];
}
}

View File

@@ -13,6 +13,8 @@ var $sanitizeMinErr = angular.$$minErr('$sanitize');
*
* {@installModule sanitize}
*
* <div doc-module-components="ngSanitize"></div>
*
* See {@link ngSanitize.$sanitize `$sanitize`} for usage.
*/

View File

@@ -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