Hopiu/angular.js
1
0
Fork 0
mirror of https://github.com/Hopiu/angular.js.git synced 2026-04-21 07:10:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc(service): update docs for the moved services

Browse source
This commit is contained in:
Misko Hevery 2011-11-09 22:23:36 -08:00
parent 74fac45f48
commit 57c37a21d1
17 changed files with 116 additions and 114 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
src/service/compiler.js
View file

@ -79,7 +79,7 @@ function $CompileProvider(){
/**
* @ngdoc function
* @name angular.compile
* @name angular.module.NG.$compile
* @function
*
* @description
@ -97,16 +97,19 @@ function $CompileProvider(){
* that is a DOM clone of the original template.
*
<pre>
// compile the entire window.document and give me the scope bound to this template.
var rootScope = angular.compile(window.document)();
angular.injector('ng').invoke(null, function($rootScope, $compile) {
// Chose one:
// compile a piece of html
var rootScope2 = angular.compile('<div ng:click="clicked = true">click me</div>')();
// A: compile the entire window.document.
var element = $compile(window.document)($rootScope);
// compile a piece of html and retain reference to both the dom and scope
var template = angular.element('<div ng:click="clicked = true">click me</div>'),
scope = angular.compile(template)();
// at this point template was transformed into a view
// B: compile a piece of html
var element = $compile('<div ng:click="clicked = true">click me</div>')($rootScope);
// C: compile a piece of html and retain reference to both the dom and scope
var element = $compile('<div ng:click="clicked = true">click me</div>')(scope);
// at this point template was transformed into a view
});
</pre>
*
*
@ -140,8 +143,9 @@ function $CompileProvider(){
* - If you are not asking the linking function to clone the template, create the DOM element(s)
* before you send them to the compiler and keep this reference around.
* <pre>
* var scope = angular.injector()('$rootScope');
* var element = angular.compile('<p>{{total}}</p>')(scope);
* var scope = angular.injector('NG')(function($rootScope, $compile){
* var element = $compile('<p>{{total}}</p>')($rootScope);
* });
* </pre>
*
* - if on the other hand, you need the element to be cloned, the view reference from the original
@ -152,7 +156,7 @@ function $CompileProvider(){
* scope = someParentScope.$new(),
* clone;
*
* angular.compile(original)(scope, function(clonedElement, scope) {
* $compile(original)(scope, function(clonedElement, scope) {
* clone = clonedElement;
* //attach the clone to DOM document at the right place
* });

16
src/service/cookieStore.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$cookieStore
* @ngdoc object
* @name angular.module.NG.$cookieStore
* @requires $cookies
*
* @description
@ -17,8 +17,8 @@ function $CookieStoreProvider(){
return {
/**
* @ngdoc method
* @name angular.service.$cookieStore#get
* @methodOf angular.service.$cookieStore
* @name angular.module.NG.$cookieStore#get
* @methodOf angular.module.NG.$cookieStore
*
* @description
* Returns the value of given cookie key
@ -32,8 +32,8 @@ function $CookieStoreProvider(){
/**
* @ngdoc method
* @name angular.service.$cookieStore#put
* @methodOf angular.service.$cookieStore
* @name angular.module.NG.$cookieStore#put
* @methodOf angular.module.NG.$cookieStore
*
* @description
* Sets a value for given cookie key
@ -47,8 +47,8 @@ function $CookieStoreProvider(){
/**
* @ngdoc method
* @name angular.service.$cookieStore#remove
* @methodOf angular.service.$cookieStore
* @name angular.module.NG.$cookieStore#remove
* @methodOf angular.module.NG.$cookieStore
*
* @description
* Remove given cookie

4
src/service/cookies.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$cookies
* @ngdoc object
* @name angular.module.NG.$cookies
* @requires $browser
*
* @description

12
src/service/defer.js
View file

@ -1,14 +1,14 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$defer
* @ngdoc function
* @name angular.module.NG.$defer
* @requires $browser
*
* @description
* Delegates to {@link angular.service.$browser $browser.defer}, but wraps the `fn` function
* Delegates to {@link angular.module.NG.$browser#defer $browser.defer}, but wraps the `fn` function
* into a try/catch block and delegates any exceptions to
* {@link angular.service.$exceptionHandler $exceptionHandler} service.
* {@link angular.module.NG.$exceptionHandler $exceptionHandler} service.
*
* In tests you can use `$browser.defer.flush()` to flush the queue of deferred functions.
*
@ -19,8 +19,8 @@
/**
* @ngdoc function
* @name angular.service.$defer#cancel
* @methodOf angular.service.$defer
* @name angular.module.NG.$defer#cancel
* @methodOf angular.module.NG.$defer
*
* @description
* Cancels a defered task identified with `deferId`.

4
src/service/document.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$document
* @ngdoc object
* @name angular.module.NG.$document
* @requires $window
*
* @description

6
src/service/exceptionHandler.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$exceptionHandler
* @ngdoc function
* @name angular.module.NG.$exceptionHandler
* @requires $log
*
* @description
@ -12,8 +12,6 @@
*
* In unit tests, if `angular-mocks.js` is loaded, this service is overriden by
* {@link angular.module.NG_MOCK.$exceptionHandler mock $exceptionHandler}
*
* @example
*/
function $ExceptionHandlerProvider(){
this.$get = ['$log', function($log){

40
src/service/location.js
View file

@ -205,8 +205,8 @@ LocationUrl.prototype = LocationHashbangUrl.prototype = {
/**
* @ngdoc method
* @name angular.service.$location#absUrl
* @methodOf angular.service.$location
* @name angular.module.NG.$location#absUrl
* @methodOf angular.module.NG.$location
*
* @description
* This method is getter only.
@ -220,8 +220,8 @@ LocationUrl.prototype = LocationHashbangUrl.prototype = {
/**
* @ngdoc method
* @name angular.service.$location#url
* @methodOf angular.service.$location
* @name angular.module.NG.$location#url
* @methodOf angular.module.NG.$location
*
* @description
* This method is getter / setter.
@ -246,8 +246,8 @@ LocationUrl.prototype = LocationHashbangUrl.prototype = {
/**
* @ngdoc method
* @name angular.service.$location#protocol
* @methodOf angular.service.$location
* @name angular.module.NG.$location#protocol
* @methodOf angular.module.NG.$location
*
* @description
* This method is getter only.
@ -260,8 +260,8 @@ LocationUrl.prototype = LocationHashbangUrl.prototype = {
/**
* @ngdoc method
* @name angular.service.$location#host
* @methodOf angular.service.$location
* @name angular.module.NG.$location#host
* @methodOf angular.module.NG.$location
*
* @description
* This method is getter only.
@ -274,8 +274,8 @@ LocationUrl.prototype = LocationHashbangUrl.prototype = {
/**
* @ngdoc method
* @name angular.service.$location#port
* @methodOf angular.service.$location
* @name angular.module.NG.$location#port
* @methodOf angular.module.NG.$location
*
* @description
* This method is getter only.
@ -288,8 +288,8 @@ LocationUrl.prototype = LocationHashbangUrl.prototype = {
/**
* @ngdoc method
* @name angular.service.$location#path
* @methodOf angular.service.$location
* @name angular.module.NG.$location#path
* @methodOf angular.module.NG.$location
*
* @description
* This method is getter / setter.
@ -310,8 +310,8 @@ LocationUrl.prototype = LocationHashbangUrl.prototype = {
/**
* @ngdoc method
* @name angular.service.$location#search
* @methodOf angular.service.$location
* @name angular.module.NG.$location#search
* @methodOf angular.module.NG.$location
*
* @description
* This method is getter / setter.
@ -343,8 +343,8 @@ LocationUrl.prototype = LocationHashbangUrl.prototype = {
/**
* @ngdoc method
* @name angular.service.$location#hash
* @methodOf angular.service.$location
* @name angular.module.NG.$location#hash
* @methodOf angular.module.NG.$location
*
* @description
* This method is getter / setter.
@ -360,8 +360,8 @@ LocationUrl.prototype = LocationHashbangUrl.prototype = {
/**
* @ngdoc method
* @name angular.service.$location#replace
* @methodOf angular.service.$location
* @name angular.module.NG.$location#replace
* @methodOf angular.module.NG.$location
*
* @description
* If called, all changes to $location during current `$digest` will be replacing current history
@ -395,8 +395,8 @@ function locationGetterSetter(property, preprocess) {
/**
* @ngdoc service
* @name angular.service.$location
* @ngdoc object
* @name angular.module.NG.$location
*
* @requires $browser
* @requires $sniffer

20
src/service/log.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$log
* @ngdoc object
* @name angular.module.NG.$log
* @requires $window
*
* @description
@ -40,8 +40,8 @@ function $LogProvider(){
return {
/**
* @ngdoc method
* @name angular.service.$log#log
* @methodOf angular.service.$log
* @name angular.module.NG.$log#log
* @methodOf angular.module.NG.$log
*
* @description
* Write a log message
@ -50,8 +50,8 @@ function $LogProvider(){
/**
* @ngdoc method
* @name angular.service.$log#warn
* @methodOf angular.service.$log
* @name angular.module.NG.$log#warn
* @methodOf angular.module.NG.$log
*
* @description
* Write a warning message
@ -60,8 +60,8 @@ function $LogProvider(){
/**
* @ngdoc method
* @name angular.service.$log#info
* @methodOf angular.service.$log
* @name angular.module.NG.$log#info
* @methodOf angular.module.NG.$log
*
* @description
* Write an information message
@ -70,8 +70,8 @@ function $LogProvider(){
/**
* @ngdoc method
* @name angular.service.$log#error
* @methodOf angular.service.$log
* @name angular.module.NG.$log#error
* @methodOf angular.module.NG.$log
*
* @description
* Write an error message

8
src/service/resource.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$resource
* @ngdoc object
* @name angular.module.NG.$resource
* @requires $xhr.cache
*
* @description
@ -10,7 +10,7 @@
* [RESTful](http://en.wikipedia.org/wiki/Representational_State_Transfer) server-side data sources.
*
* The returned resource object has action methods which provide high-level behaviors without
* the need to interact with the low level {@link angular.service.$xhr $xhr} service or
* the need to interact with the low level {@link angular.module.NG.$xhr $xhr} service or
* raw XMLHttpRequest.
*
* @param {string} url A parameterized URL template with parameters prefixed by `:` as in
@ -57,7 +57,7 @@
* 'remove': {method:'DELETE'},
* 'delete': {method:'DELETE'} };
*
* Calling these methods invoke an {@link angular.service.$xhr} with the specified http method,
* Calling these methods invoke an {@link angular.module.NG.$xhr} with the specified http method,
* destination and parameters. When the data is returned from the server then the object is an
* instance of the resource class `save`, `remove` and `delete` actions are available on it as
* methods with the `$` prefix. This allows you to easily perform CRUD operations (create, read,

44
src/service/route.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$route
* @ngdoc object
* @name angular.module.NG.$route
* @requires $location
* @requires $routeParams
*
@ -14,7 +14,7 @@
* definition. It is used for deep-linking URLs to controllers and views (HTML partials).
*
* The `$route` service is typically used in conjunction with {@link angular.widget.ng:view ng:view}
* widget and the {@link angular.service.$routeParams $routeParams} service.
* widget and the {@link angular.module.NG.$routeParams $routeParams} service.
*
* @example
This example shows how changing the URL hash causes the <tt>$route</tt>
@ -67,8 +67,8 @@ function $RouteProvider(){
function( $rootScope, $location, $routeParams) {
/**
* @ngdoc event
* @name angular.service.$route#$beforeRouteChange
* @eventOf angular.service.$route
* @name angular.module.NG.$route#$beforeRouteChange
* @eventOf angular.module.NG.$route
* @eventType broadcast on root scope
* @description
* Broadcasted before a route change.
@ -79,14 +79,14 @@ function $RouteProvider(){
* The `Route` object extends the route definition with the following properties.
*
* * `scope` - The instance of the route controller.
* * `params` - The current {@link angular.service.$routeParams params}.
* * `params` - The current {@link angular.module.NG.$routeParams params}.
*
*/
/**
* @ngdoc event
* @name angular.service.$route#$afterRouteChange
* @eventOf angular.service.$route
* @name angular.module.NG.$route#$afterRouteChange
* @eventOf angular.module.NG.$route
* @eventType broadcast on root scope
* @description
* Broadcasted after a route change.
@ -97,14 +97,14 @@ function $RouteProvider(){
* The `Route` object extends the route definition with the following properties.
*
* * `scope` - The instance of the route controller.
* * `params` - The current {@link angular.service.$routeParams params}.
* * `params` - The current {@link angular.module.NG.$routeParams params}.
*
*/
/**
* @ngdoc event
* @name angular.service.$route#$routeUpdate
* @eventOf angular.service.$route
* @name angular.module.NG.$route#$routeUpdate
* @eventOf angular.module.NG.$route
* @eventType emit on the current route scope
* @description
*
@ -122,8 +122,8 @@ function $RouteProvider(){
/**
* @ngdoc method
* @name angular.service.$route#parent
* @methodOf angular.service.$route
* @name angular.module.NG.$route#parent
* @methodOf angular.module.NG.$route
*
* @param {Scope} [scope=rootScope] Scope to be used as parent for newly created
* `$route.current.scope` scopes.
@ -138,8 +138,8 @@ function $RouteProvider(){
/**
* @ngdoc method
* @name angular.service.$route#when
* @methodOf angular.service.$route
* @name angular.module.NG.$route#when
* @methodOf angular.module.NG.$route
*
* @param {string} path Route path (matched against `$location.hash`)
* @param {Object} route Mapping information to be assigned to `$route.current` on route
@ -153,7 +153,7 @@ function $RouteProvider(){
* {@link angular.widget.ng:view ng:view} or
* {@link angular.widget.ng:include ng:include} widgets.
* - `redirectTo` – {(string|function())=} – value to update
* {@link angular.service.$location $location} path with and trigger route redirection.
* {@link angular.module.NG.$location $location} path with and trigger route redirection.
*
* If `redirectTo` is a function, it will be called with the following parameters:
*
@ -170,7 +170,7 @@ function $RouteProvider(){
*
* If the option is set to false and url in the browser changes, then
* $routeUpdate event is emited on the current route scope. You can use this event to
* react to {@link angular.service.$routeParams} changes:
* react to {@link angular.module.NG.$routeParams} changes:
*
* function MyCtrl($route, $routeParams) {
* this.$on('$routeUpdate', function() {
@ -193,8 +193,8 @@ function $RouteProvider(){
/**
* @ngdoc method
* @name angular.service.$route#otherwise
* @methodOf angular.service.$route
* @name angular.module.NG.$route#otherwise
* @methodOf angular.module.NG.$route
*
* @description
* Sets route definition that will be used on route change when no other route definition
@ -208,12 +208,12 @@ function $RouteProvider(){
/**
* @ngdoc method
* @name angular.service.$route#reload
* @methodOf angular.service.$route
* @name angular.module.NG.$route#reload
* @methodOf angular.module.NG.$route
*
* @description
* Causes `$route` service to reload (and recreate the `$route.current` scope) upon the next
* eval even if {@link angular.service.$location $location} hasn't changed.
* eval even if {@link angular.module.NG.$location $location} hasn't changed.
*/
reload: function() {
dirty++;

8
src/service/routeParams.js
View file

@ -1,14 +1,14 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$routeParams
* @ngdoc object
* @name angular.module.NG.$routeParams
* @requires $route
*
* @description
* Current set of route parameters. The route parameters are a combination of the
* {@link angular.service.$location $location} `search()`, and `path()`. The `path` parameters
* are extracted when the {@link angular.service.$route $route} path is matched.
* {@link angular.module.NG.$location $location} `search()`, and `path()`. The `path` parameters
* are extracted when the {@link angular.module.NG.$route $route} path is matched.
*
* In case of parameter name collision, `path` params take precedence over `search` params.
*

4
src/service/sniffer.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$sniffer
* @ngdoc object
* @name angular.module.NG.$sniffer
* @requires $window
*
* @property {boolean} history Does the browser support html5 history api ?

4
src/service/window.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$window
* @ngdoc object
* @name angular.module.NG.$window
*
* @description
* A reference to the browser's `window` object. While `window`

4
src/service/xhr.bulk.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$xhr.bulk
* @ngdoc object
* @name angular.module.NG.$xhr.bulk
* @requires $xhr
* @requires $xhr.error
* @requires $log

8
src/service/xhr.cache.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$xhr.cache
* @ngdoc object
* @name angular.module.NG.$xhr.cache
* @function
*
* @requires $xhr.bulk
@ -11,11 +11,11 @@
* @requires $log
*
* @description
* Acts just like the {@link angular.service.$xhr $xhr} service but caches responses for `GET`
* Acts just like the {@link angular.module.NG.$xhr $xhr} service but caches responses for `GET`
* requests. All cache misses are delegated to the $xhr service.
*
* @property {function()} delegate Function to delegate all the cache misses to. Defaults to
* the {@link angular.service.$xhr $xhr} service.
* the {@link angular.module.NG.$xhr $xhr} service.
* @property {object} data The hashmap where all cached entries are stored.
*
* @param {string} method HTTP method.

8
src/service/xhr.error.js
View file

@ -1,15 +1,15 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$xhr.error
* @ngdoc object
* @name angular.module.NG.$xhr.error
* @function
* @requires $log
*
* @description
* Error handler for {@link angular.service.$xhr $xhr service}. An application can replaces this
* Error handler for {@link angular.module.NG.$xhr $xhr service}. An application can replaces this
* service with one specific for the application. The default implementation logs the error to
* {@link angular.service.$log $log.error}.
* {@link angular.module.NG.$log $log.error}.
*
* @param {Object} request Request object.
*

12
src/service/xhr.js
View file

@ -1,8 +1,8 @@
'use strict';
/**
* @ngdoc service
* @name angular.service.$xhr
* @ngdoc object
* @name angular.module.NG.$xhr
* @function
* @requires $browser $xhr delegates all XHR requests to the `$browser.xhr()`. A mock version
* of the $browser exists which allows setting expectations on XHR requests
@ -12,14 +12,14 @@
*
* @description
* Generates an XHR request. The $xhr service delegates all requests to
* {@link angular.service.$browser $browser.xhr()} and adds error handling and security features.
* {@link angular.module.NG.$browser $browser.xhr()} and adds error handling and security features.
* While $xhr service provides nicer api than raw XmlHttpRequest, it is still considered a lower
* level api in angular. For a higher level abstraction that utilizes `$xhr`, please check out the
* {@link angular.service.$resource $resource} service.
* {@link angular.module.NG.$resource $resource} service.
*
* # Error handling
* If no `error callback` is specified, XHR response with response code other then `2xx` will be
* delegated to {@link angular.service.$xhr.error $xhr.error}. The `$xhr.error` can intercept the
* delegated to {@link angular.module.NG.$xhr.error $xhr.error}. The `$xhr.error` can intercept the
* request and process it in application specific way, or resume normal execution by calling the
* request `success` method.
*
@ -98,7 +98,7 @@
*
* - {number} code [HTTP status code](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) of
* the response. This will currently always be 200, since all non-200 responses are routed to
* {@link angular.service.$xhr.error} service (or custom error callback).
* {@link angular.module.NG.$xhr.error} service (or custom error callback).
* - {string|Object} response Response object as string or an Object if the response was in JSON
* format.
* @param {function(number, (string|Object))} error A function to be called if the response code is