diff options
Diffstat (limited to 'src/service')
| -rw-r--r-- | src/service/compiler.js | 6 | ||||
| -rw-r--r-- | src/service/filter/filter.js | 2 | ||||
| -rw-r--r-- | src/service/filter/limitTo.js | 2 | ||||
| -rw-r--r-- | src/service/filter/orderBy.js | 2 | ||||
| -rw-r--r-- | src/service/formFactory.js | 2 | ||||
| -rw-r--r-- | src/service/location.js | 24 | ||||
| -rw-r--r-- | src/service/scope.js | 76 |
7 files changed, 68 insertions, 46 deletions
diff --git a/src/service/compiler.js b/src/service/compiler.js index 1e07d47c..56ec82e2 100644 --- a/src/service/compiler.js +++ b/src/service/compiler.js @@ -84,7 +84,7 @@ function $CompileProvider(){ * * @description * Compiles a piece of HTML string or DOM into a template and produces a template function, which - * can then be used to link {@link angular.scope scope} and the template together. + * can then be used to link {@link angular.module.NG.$rootScope.Scope scope} and the template together. * * The compilation is a process of walking the DOM tree and trying to match DOM elements to * {@link angular.markup markup}, {@link angular.attrMarkup attrMarkup}, @@ -117,7 +117,7 @@ function $CompileProvider(){ * @returns {function(scope[, cloneAttachFn])} a template function which is used to bind template * (a DOM element/tree) to a scope. Where: * - * * `scope` - A {@link angular.scope Scope} to bind to. + * * `scope` - A {@link angular.module.NG.$rootScope.Scope Scope} to bind to. * * `cloneAttachFn` - If `cloneAttachFn` is provided, then the link function will clone the * `template` and call the `cloneAttachFn` function allowing the caller to attach the * cloned elements to the DOM document at the appropriate place. The `cloneAttachFn` is @@ -136,7 +136,7 @@ function $CompileProvider(){ * bring the view to life, the scope needs to run through a $digest phase which typically is done by * Angular automatically, except for the case when an application is being * {@link guide/dev_guide.bootstrap.manual_bootstrap} manually bootstrapped, in which case the - * $digest phase must be invoked by calling {@link angular.scope.$apply}. + * $digest phase must be invoked by calling {@link angular.module.NG.$rootScope.Scope#$apply}. * * If you need access to the bound view, there are two ways to do it: * diff --git a/src/service/filter/filter.js b/src/service/filter/filter.js index 7efd6618..7008c312 100644 --- a/src/service/filter/filter.js +++ b/src/service/filter/filter.js @@ -9,7 +9,7 @@ * Selects a subset of items from `array` and returns it as a new array. * * Note: This function is used to augment the `Array` type in Angular expressions. See - * {@link angular.Array} for more information about Angular arrays. + * {@link angular.module.NG.$filter} for more information about Angular arrays. * * @param {Array} array The source array. * @param {string|Object|function()} expression The predicate to be used for selecting items from diff --git a/src/service/filter/limitTo.js b/src/service/filter/limitTo.js index ca1f49cb..cc9646c2 100644 --- a/src/service/filter/limitTo.js +++ b/src/service/filter/limitTo.js @@ -11,7 +11,7 @@ * value and sign (positive or negative) of `limit`. * * Note: This function is used to augment the `Array` type in Angular expressions. See - * {@link angular.Array} for more information about Angular arrays. + * {@link angular.module.NG.$filter} for more information about Angular arrays. * * @param {Array} array Source array to be limited. * @param {string|Number} limit The length of the returned array. If the `limit` number is diff --git a/src/service/filter/orderBy.js b/src/service/filter/orderBy.js index abbffef7..c9e6ae9f 100644 --- a/src/service/filter/orderBy.js +++ b/src/service/filter/orderBy.js @@ -9,7 +9,7 @@ * Orders a specified `array` by the `expression` predicate. * * Note: this function is used to augment the `Array` type in Angular expressions. See - * {@link angular.Array} for more informaton about Angular arrays. + * {@link angular.module.NG.$filter} for more informaton about Angular arrays. * * @param {Array} array The array to sort. * @param {function(*)|string|Array.<(function(*)|string)>} expression A predicate to be diff --git a/src/service/formFactory.js b/src/service/formFactory.js index 854d9a6e..f0e4b5ac 100644 --- a/src/service/formFactory.js +++ b/src/service/formFactory.js @@ -11,7 +11,7 @@ * The form instance is a collection of widgets, and is responsible for life cycle and validation * of widget. * - * Keep in mind that both form and widget instances are {@link api/angular.scope scopes}. + * Keep in mind that both form and widget instances are {@link api/angular.module.NG.$rootScope.Scope scopes}. * * @param {Form=} parentForm The form which should be the parent form of the new form controller. * If none specified default to the `rootForm`. diff --git a/src/service/location.js b/src/service/location.js index 4d82dfae..532ee3af 100644 --- a/src/service/location.js +++ b/src/service/location.js @@ -401,7 +401,6 @@ function locationGetterSetter(property, preprocess) { * * @requires $browser * @requires $sniffer - * @requires $locationConfig * @requires $document * * @description @@ -420,10 +419,25 @@ function locationGetterSetter(property, preprocess) { * * For more information see {@link guide/dev_guide.services.$location Developer Guide: Angular Services: Using $location} */ + +/** + * @ngdoc object + * @name angular.module.NG.$locationProvider + * @description + * Use the `$locationPrvoder` to configure how the application deep linking paths are stored. + */ function $LocationProvider(){ var hashPrefix = '', html5Mode = false; + /** + * @ngdoc property + * @name angular.module.NG.$locationProvider#hashPrefix + * @methodOf angular.module.NG.$locationProvider + * @description + * @param {string=} prefix Prefix for hash part (containing path and search) + * @returns current value if used as getter or itself (chaining) if used as setter + */ this.hashPrefix = function(prefix) { if (isDefined(prefix)) { hashPrefix = prefix; @@ -433,6 +447,14 @@ function $LocationProvider(){ } } + /** + * @ngdoc property + * @name angular.module.NG.$locationProvider#hashPrefix + * @propertyOf angular.module.NG.$locationProvider + * @description + * @param mode= Use HTML5 strategy if available. + * @returns current value if used as getter or itself (chaining) if used as setter + */ this.html5Mode = function(mode) { if (isDefined(mode)) { html5Mode = mode; diff --git a/src/service/scope.js b/src/service/scope.js index e80c338e..afc152f7 100644 --- a/src/service/scope.js +++ b/src/service/scope.js @@ -30,7 +30,7 @@ * @name angular.module.NG.$rootScope * @description * - * Every application has a single root {@link angular.model.NG.$rootScope.Scope scope}. + * Every application has a single root {@link angular.module.NG.$rootScope.Scope scope}. * All other scopes are child scopes of the root scope. Scopes provide mechanism for watching the model and provide * event processing life-cycle. See {@link guide/dev_guide.scopes developer guide on scopes}. */ @@ -43,8 +43,8 @@ function $RootScopeProvider(){ * * @description * A root scope can be retrieved using the {@link angular.module.NG.$rootScope $rootScope} key from the - * {@link angular.model.AUTO.$injector $injector}. Child scopes are created using the - * {@link angular.module.NG.$rootScope.Scope.$new $new()} method. (Most scopes are created automatically when + * {@link angular.module.AUTO.$injector $injector}. Child scopes are created using the + * {@link angular.module.NG.$rootScope.Scope#$new $new()} method. (Most scopes are created automatically when * compiled HTML template is executed.) * * Here is a simple scope snippet to show how you can interact with the scope. @@ -90,7 +90,7 @@ function $RootScopeProvider(){ * * * @param {Object.<string, function()>=} providers Map of service factory which need to be provided - * for the current scope. Defaults to {@link angular.service}. + * for the current scope. Defaults to {@link angular.module.NG}. * @param {Object.<string, *>=} instanceCache Provides pre-instantiated services which should * append/override services provided by `providers`. This is handy when unit-testing and having * the need to override a default service. @@ -126,11 +126,11 @@ function $RootScopeProvider(){ * * @description * Creates a new child {@link angular.module.NG.$rootScope.Scope scope}. The new scope can optionally behave as a - * controller. The parent scope will propagate the {@link angular.module.NG.$rootScope.Scope.$digest $digest()} and - * {@link angular.module.NG.$rootScope.Scope.$digest $digest()} events. The scope can be removed from the scope - * hierarchy using {@link angular.module.NG.$rootScope.Scope.$destroy $destroy()}. + * controller. The parent scope will propagate the {@link angular.module.NG.$rootScope.Scope#$digest $digest()} and + * {@link angular.module.NG.$rootScope.Scope#$digest $digest()} events. The scope can be removed from the scope + * hierarchy using {@link angular.module.NG.$rootScope.Scope#$destroy $destroy()}. * - * {@link angular.module.NG.$rootScope.Scope.$destroy $destroy()} must be called on a scope when it is desired for + * {@link angular.module.NG.$rootScope.Scope#$destroy $destroy()} must be called on a scope when it is desired for * the scope and its child scopes to be permanently detached from the parent and thus stop * participating in model change detection and listener notification by invoking. * @@ -182,10 +182,10 @@ function $RootScopeProvider(){ * @description * Registers a `listener` callback to be executed whenever the `watchExpression` changes. * - * - The `watchExpression` is called on every call to {@link angular.module.NG.$rootScope.Scope.$digest $digest()} and - * should return the value which will be watched. (Since {@link angular.module.NG.$rootScope.Scope.$digest $digest()} + * - The `watchExpression` is called on every call to {@link angular.module.NG.$rootScope.Scope#$digest $digest()} and + * should return the value which will be watched. (Since {@link angular.module.NG.$rootScope.Scope#$digest $digest()} * reruns when it detects changes the `watchExpression` can execute multiple times per - * {@link angular.module.NG.$rootScope.Scope.$digest $digest()} and should be idempotent.) + * {@link angular.module.NG.$rootScope.Scope#$digest $digest()} and should be idempotent.) * - The `listener` is called only when the value from the current `watchExpression` and the * previous call to `watchExpression' are not equal. The inequality is determined according to * {@link angular.equals} function. To save the value of the object for later comparison @@ -196,9 +196,9 @@ function $RootScopeProvider(){ * limit is 100 to prevent infinity loop deadlock. * * - * If you want to be notified whenever {@link angular.module.NG.$rootScope.Scope.$digest $digest} is called, + * If you want to be notified whenever {@link angular.module.NG.$rootScope.Scope#$digest $digest} is called, * you can register an `watchExpression` function with no `listener`. (Since `watchExpression`, - * can execute multiple times per {@link angular.module.NG.$rootScope.Scope.$digest $digest} cycle when a change is + * can execute multiple times per {@link angular.module.NG.$rootScope.Scope#$digest $digest} cycle when a change is * detected, be prepared for multiple calls to your listener.) * * @@ -224,7 +224,7 @@ function $RootScopeProvider(){ * * * @param {(function()|string)} watchExpression Expression that is evaluated on each - * {@link angular.module.NG.$rootScope.Scope.$digest $digest} cycle. A change in the return value triggers a + * {@link angular.module.NG.$rootScope.Scope#$digest $digest} cycle. A change in the return value triggers a * call to the `listener`. * * - `string`: Evaluated as {@link guide/dev_guide.expressions expression} @@ -268,19 +268,19 @@ function $RootScopeProvider(){ * @function * * @description - * Process all of the {@link angular.module.NG.$rootScope.Scope.$watch watchers} of the current scope and its children. - * Because a {@link angular.module.NG.$rootScope.Scope.$watch watcher}'s listener can change the model, the - * `$digest()` keeps calling the {@link angular.module.NG.$rootScope.Scope.$watch watchers} until no more listeners are + * Process all of the {@link angular.module.NG.$rootScope.Scope#$watch watchers} of the current scope and its children. + * Because a {@link angular.module.NG.$rootScope.Scope#$watch watcher}'s listener can change the model, the + * `$digest()` keeps calling the {@link angular.module.NG.$rootScope.Scope#$watch watchers} until no more listeners are * firing. This means that it is possible to get into an infinite loop. This function will throw * `'Maximum iteration limit exceeded.'` if the number of iterations exceeds 100. * * Usually you don't call `$digest()` directly in * {@link angular.directive.ng:controller controllers} or in {@link angular.directive directives}. - * Instead a call to {@link angular.module.NG.$rootScope.Scope.$apply $apply()} (typically from within a + * Instead a call to {@link angular.module.NG.$rootScope.Scope#$apply $apply()} (typically from within a * {@link angular.directive directive}) will force a `$digest()`. * * If you want to be notified whenever `$digest()` is called, - * you can register a `watchExpression` function with {@link angular.module.NG.$rootScope.Scope.$watch $watch()} + * you can register a `watchExpression` function with {@link angular.module.NG.$rootScope.Scope#$watch $watch()} * with no `listener`. * * You may have a need to call `$digest()` from within unit-tests, to simulate the scope @@ -388,11 +388,11 @@ function $RootScopeProvider(){ * * @description * Remove the current scope (and all of its children) from the parent scope. Removal implies - * that calls to {@link angular.module.NG.$rootScope.Scope.$digest $digest()} will no longer propagate to the current + * that calls to {@link angular.module.NG.$rootScope.Scope#$digest $digest()} will no longer propagate to the current * scope and its children. Removal also implies that the current scope is eligible for garbage * collection. * - * The destructing scope emits an `$destroy` {@link angular.module.NG.$rootScope.Scope.$emit event}. + * The destructing scope emits an `$destroy` {@link angular.module.NG.$rootScope.Scope#$emit event}. * * The `$destroy()` is usually used by directives such as * {@link angular.widget.@ng:repeat ng:repeat} for managing the unrolling of the loop. @@ -452,11 +452,11 @@ function $RootScopeProvider(){ * The `$evalAsync` makes no guarantees as to when the `expression` will be executed, only that: * * - it will execute in the current script execution context (before any DOM rendering). - * - at least one {@link angular.module.NG.$rootScope.Scope.$digest $digest cycle} will be performed after + * - at least one {@link angular.module.NG.$rootScope.Scope#$digest $digest cycle} will be performed after * `expression` execution. * * Any exceptions from the execution of the expression are forwarded to the - * {@link angular.service.$exceptionHandler $exceptionHandler} service. + * {@link angular.module.NG.$exceptionHandler $exceptionHandler} service. * * @param {(string|function())=} expression An angular expression to be executed. * @@ -478,8 +478,8 @@ function $RootScopeProvider(){ * `$apply()` is used to execute an expression in angular from outside of the angular framework. * (For example from browser DOM events, setTimeout, XHR or third party libraries). * Because we are calling into the angular framework we need to perform proper scope life-cycle - * of {@link angular.service.$exceptionHandler exception handling}, - * {@link angular.module.NG.$rootScope.Scope.$digest executing watches}. + * of {@link angular.module.NG.$exceptionHandler exception handling}, + * {@link angular.module.NG.$rootScope.Scope#$digest executing watches}. * * ## Life cycle * @@ -498,11 +498,11 @@ function $RootScopeProvider(){ * Scope's `$apply()` method transitions through the following stages: * * 1. The {@link guide/dev_guide.expressions expression} is executed using the - * {@link angular.module.NG.$rootScope.Scope.$eval $eval()} method. + * {@link angular.module.NG.$rootScope.Scope#$eval $eval()} method. * 2. Any exceptions from the execution of the expression are forwarded to the - * {@link angular.service.$exceptionHandler $exceptionHandler} service. - * 3. The {@link angular.module.NG.$rootScope.Scope.$watch watch} listeners are fired immediately after the expression - * was executed using the {@link angular.module.NG.$rootScope.Scope.$digest $digest()} method. + * {@link angular.module.NG.$exceptionHandler $exceptionHandler} service. + * 3. The {@link angular.module.NG.$rootScope.Scope#$watch watch} listeners are fired immediately after the expression + * was executed using the {@link angular.module.NG.$rootScope.Scope#$digest $digest()} method. * * * @param {(string|function())=} exp An angular expression to be executed. @@ -529,7 +529,7 @@ function $RootScopeProvider(){ * @function * * @description - * Listen on events of a given type. See {@link angular.module.NG.$rootScope.Scope.$emit $emit} for discussion of + * Listen on events of a given type. See {@link angular.module.NG.$rootScope.Scope#$emit $emit} for discussion of * event life cycle. * * @param {string} name Event name to listen on. @@ -565,15 +565,15 @@ function $RootScopeProvider(){ * * @description * Dispatches an event `name` upwards through the scope hierarchy notifying the - * registered {@link angular.module.NG.$rootScope.Scope.$on} listeners. + * registered {@link angular.module.NG.$rootScope.Scope#$on} listeners. * * The event life cycle starts at the scope on which `$emit` was called. All - * {@link angular.module.NG.$rootScope.Scope.$on listeners} listening for `name` event on this scope get notified. + * {@link angular.module.NG.$rootScope.Scope#$on listeners} listening for `name` event on this scope get notified. * Afterwards, the event traverses upwards toward the root scope and calls all registered * listeners along the way. The event will stop propagating if one of the listeners cancels it. * - * Any exception emmited from the {@link angular.module.NG.$rootScope.Scope.$on listeners} will be passed - * onto the {@link angular.service.$exceptionHandler $exceptionHandler} service. + * Any exception emmited from the {@link angular.module.NG.$rootScope.Scope#$on listeners} will be passed + * onto the {@link angular.module.NG.$exceptionHandler $exceptionHandler} service. * * @param {string} name Event name to emit. * @param {...*} args Optional set of arguments which will be passed onto the event listeners. @@ -616,15 +616,15 @@ function $RootScopeProvider(){ * * @description * Dispatches an event `name` downwards to all child scopes (and their children) notifying the - * registered {@link angular.module.NG.$rootScope.Scope.$on} listeners. + * registered {@link angular.module.NG.$rootScope.Scope#$on} listeners. * * The event life cycle starts at the scope on which `$broadcast` was called. All - * {@link angular.module.NG.$rootScope.Scope.$on listeners} listening for `name` event on this scope get notified. + * {@link angular.module.NG.$rootScope.Scope#$on listeners} listening for `name` event on this scope get notified. * Afterwards, the event propagates to all direct and indirect scopes of the current scope and * calls all registered listeners along the way. The event cannot be canceled. * - * Any exception emmited from the {@link angular.module.NG.$rootScope.Scope.$on listeners} will be passed - * onto the {@link angular.service.$exceptionHandler $exceptionHandler} service. + * Any exception emmited from the {@link angular.module.NG.$rootScope.Scope#$on listeners} will be passed + * onto the {@link angular.module.NG.$exceptionHandler $exceptionHandler} service. * * @param {string} name Event name to emit. * @param {...*} args Optional set of arguments which will be passed onto the event listeners. |