diff options
| author | Vojta Jina | 2013-10-17 19:25:08 -0700 |
|---|---|---|
| committer | Igor Minar | 2013-10-18 15:35:41 -0700 |
| commit | 14438058da39c3e523f420549074934ca5881b09 (patch) | |
| tree | acc97d90025e9d80f9869012554763233f412caf /src | |
| parent | e8cc85f733a49ca53e8cda5a96bbaacc9a20ac7e (diff) | |
| download | angular.js-14438058da39c3e523f420549074934ca5881b09.tar.bz2 | |
docs: correct broken links
This also contains some whitespace corrections by my editor.
Diffstat (limited to 'src')
| -rw-r--r-- | src/auto/injector.js | 36 | ||||
| -rw-r--r-- | src/jqLite.js | 2 | ||||
| -rw-r--r-- | src/loader.js | 4 | ||||
| -rw-r--r-- | src/ng/compile.js | 2 | ||||
| -rw-r--r-- | src/ng/controller.js | 2 | ||||
| -rw-r--r-- | src/ng/directive/input.js | 6 | ||||
| -rw-r--r-- | src/ng/directive/ngBind.js | 6 | ||||
| -rw-r--r-- | src/ng/directive/ngInclude.js | 6 | ||||
| -rw-r--r-- | src/ng/http.js | 12 | ||||
| -rw-r--r-- | src/ng/interpolate.js | 2 | ||||
| -rw-r--r-- | src/ng/interval.js | 4 | ||||
| -rw-r--r-- | src/ng/rootScope.js | 6 | ||||
| -rw-r--r-- | src/ng/sce.js | 111 | ||||
| -rw-r--r-- | src/ng/timeout.js | 2 | ||||
| -rw-r--r-- | src/ngAnimate/animate.js | 18 | ||||
| -rw-r--r-- | src/ngMock/angular-mocks.js | 20 | ||||
| -rw-r--r-- | src/ngResource/resource.js | 2 | ||||
| -rw-r--r-- | src/ngRoute/routeParams.js | 2 |
18 files changed, 122 insertions, 121 deletions
diff --git a/src/auto/injector.js b/src/auto/injector.js index 3676ee59..075f3ee8 100644 --- a/src/auto/injector.js +++ b/src/auto/injector.js @@ -276,26 +276,26 @@ function annotate(fn) { * factories** are functions which, in turn, are created by a **service provider**. * The **service providers** are constructor functions. When instantiated they must contain a property * called `$get`, which holds the **service factory** function. - * + * * When you request a service, the {@link AUTO.$injector $injector} is responsible for finding the * correct **service provider**, instantiating it and then calling its `$get` **service factory** * function to get the instance of the **service**. - * + * * Often services have no configuration options and there is no need to add methods to the service * provider. The provider will be no more than a constructor function with a `$get` property. For * these cases the {@link AUTO.$provide $provide} service has additional helper methods to register * services without specifying a provider. * - * * {@link AUTO.$provide#provider provider(provider)} - registers a **service provider** with the + * * {@link AUTO.$provide#methods_provider provider(provider)} - registers a **service provider** with the * {@link AUTO.$injector $injector} - * * {@link AUTO.$provide#constant constant(obj)} - registers a value/object that can be accessed by + * * {@link AUTO.$provide#methods_constant constant(obj)} - registers a value/object that can be accessed by * providers and services. - * * {@link AUTO.$provide#value value(obj)} - registers a value/object that can only be accessed by + * * {@link AUTO.$provide#methods_value value(obj)} - registers a value/object that can only be accessed by * services, not providers. - * * {@link AUTO.$provide#factory factory(fn)} - registers a service **factory function**, `fn`, that + * * {@link AUTO.$provide#methods_factory factory(fn)} - registers a service **factory function**, `fn`, that * will be wrapped in a **service provider** object, whose `$get` property will contain the given * factory function. - * * {@link AUTO.$provide#service service(class)} - registers a **constructor function**, `class` that + * * {@link AUTO.$provide#methods_service service(class)} - registers a **constructor function**, `class` that * will be wrapped in a **service provider** object, whose `$get` property will instantiate a new * object using the given constructor function. * @@ -310,7 +310,7 @@ function annotate(fn) { * * Register a **provider function** with the {@link AUTO.$injector $injector}. Provider functions are * constructor functions, whose instances are responsible for "providing" a factory for a service. - * + * * Service provider names start with the name of the service they provide followed by `Provider`. * For example, the {@link ng.$log $log} service has a provider called {@link ng.$logProvider $logProvider}. * @@ -334,7 +334,7 @@ function annotate(fn) { * @example * * The following example shows how to create a simple event tracking service and register it using - * {@link AUTO.$provide#provider $provide.provider()}. + * {@link AUTO.$provide#methods_provider $provide.provider()}. * * <pre> * // Define the eventTracker provider @@ -414,7 +414,7 @@ function annotate(fn) { * @returns {Object} registered provider instance * * @example - * Here is an example of registering a service + * Here is an example of registering a service * <pre> * $provide.factory('ping', ['$http', function($http) { * return function ping() { @@ -441,7 +441,7 @@ function annotate(fn) { * This is short for registering a service where its provider's `$get` property is the service * constructor function that will be used to instantiate the service instance. * - * You should use {@link AUTO.$provide#service $provide.service(class)} if you define your service + * You should use {@link AUTO.$provide#methods_service $provide.service(class)} if you define your service * as a type/class. This is common when using {@link http://coffeescript.org CoffeeScript}. * * @param {string} name The name of the instance. @@ -449,14 +449,14 @@ function annotate(fn) { * @returns {Object} registered provider instance * * @example - * Here is an example of registering a service using {@link AUTO.$provide#service $provide.service(class)} + * Here is an example of registering a service using {@link AUTO.$provide#methods_service $provide.service(class)} * that is defined as a CoffeeScript class. * <pre> * class Ping * constructor: (@$http)-> * send: ()=> * @$http.get('/ping') - * + * * $provide.service('ping', ['$http', Ping]) * </pre> * You would then inject and use this service like this: @@ -481,7 +481,7 @@ function annotate(fn) { * Value services are similar to constant services, except that they cannot be injected into a module * configuration function (see {@link angular.Module#config}) but they can be overridden by an Angular * {@link AUTO.$provide#decorator decorator}. - * + * * @param {string} name The name of the instance. * @param {*} value The value. * @returns {Object} registered provider instance @@ -490,9 +490,9 @@ function annotate(fn) { * Here are some examples of creating value services. * <pre> * $provide.constant('ADMIN_USER', 'admin'); - * + * * $provide.constant('RoleLookup', { admin: 0, writer: 1, reader: 2 }); - * + * * $provide.constant('halfOf', function(value) { * return value / 2; * }); @@ -519,9 +519,9 @@ function annotate(fn) { * Here a some examples of creating constants: * <pre> * $provide.constant('SHARD_HEIGHT', 306); - * + * * $provide.constant('MY_COLOURS', ['red', 'blue', 'grey']); - * + * * $provide.constant('double', function(value) { * return value * 2; * }); diff --git a/src/jqLite.js b/src/jqLite.js index 60c156e4..ceec8d0b 100644 --- a/src/jqLite.js +++ b/src/jqLite.js @@ -804,7 +804,7 @@ forEach({ triggerHandler: function(element, eventName, eventData) { var eventFns = (JQLiteExpandoStore(element, 'events') || {})[eventName]; - + eventData = eventData || []; var event = [{ diff --git a/src/loader.js b/src/loader.js index 15dab8f6..7c7d3082 100644 --- a/src/loader.js +++ b/src/loader.js @@ -66,7 +66,7 @@ function setupModuleLoader(window) { * @param {Array.<string>=} requires If specified then new module is being created. If unspecified then the * the module is being retrieved for further configuration. * @param {Function} configFn Optional configuration function for the module. Same as - * {@link angular.Module#config Module#config()}. + * {@link angular.Module#methods_config Module#config()}. * @returns {module} new module with the {@link angular.Module} api. */ return function module(name, requires, configFn) { @@ -236,7 +236,7 @@ function setupModuleLoader(window) { * @param {Function} directiveFactory Factory function for creating new instance of * directives. * @description - * See {@link ng.$compileProvider#directive $compileProvider.directive()}. + * See {@link ng.$compileProvider#methods_directive $compileProvider.directive()}. */ directive: invokeLater('$compileProvider', 'directive'), diff --git a/src/ng/compile.js b/src/ng/compile.js index c44985fd..84546f39 100644 --- a/src/ng/compile.js +++ b/src/ng/compile.js @@ -28,7 +28,7 @@ * can then be used to link {@link 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 ng.$compileProvider#directive directives}. For each match it + * {@link ng.$compileProvider#methods_directive directives}. For each match it * executes corresponding template function and collects the * instance functions into a single template function which is then returned. * diff --git a/src/ng/controller.js b/src/ng/controller.js index dc291c8c..827d807b 100644 --- a/src/ng/controller.js +++ b/src/ng/controller.js @@ -8,7 +8,7 @@ * controllers. * * This provider allows controller registration via the - * {@link ng.$controllerProvider#register register} method. + * {@link ng.$controllerProvider#methods_register register} method. */ function $ControllerProvider() { var controllers = {}, diff --git a/src/ng/directive/input.js b/src/ng/directive/input.js index 8ea66d09..87afc328 100644 --- a/src/ng/directive/input.js +++ b/src/ng/directive/input.js @@ -818,7 +818,7 @@ var VALID_CLASS = 'ng-valid', the control reads value from the DOM. Each function is called, in turn, passing the value through to the next. Used to sanitize / convert the value as well as validation. For validation, the parsers should update the validity state using - {@link ng.directive:ngModel.NgModelController#$setValidity $setValidity()}, + {@link ng.directive:ngModel.NgModelController#methods_$setValidity $setValidity()}, and return `undefined` for invalid values. * @@ -999,10 +999,10 @@ var NgModelController = ['$scope', '$exceptionHandler', '$attrs', '$element', '$ * * @description * This is called when we need to determine if the value of the input is empty. - * + * * For instance, the required directive does this to work out if the input has data or not. * The default `$isEmpty` function checks whether the value is `undefined`, `''`, `null` or `NaN`. - * + * * You can override this for input directives whose concept of being empty is different to the * default. The `checkboxInputType` directive does this because in its case a value of `false` * implies empty. diff --git a/src/ng/directive/ngBind.js b/src/ng/directive/ngBind.js index 64a2d821..c55ab076 100644 --- a/src/ng/directive/ngBind.js +++ b/src/ng/directive/ngBind.js @@ -13,8 +13,8 @@ * Typically, you don't use `ngBind` directly, but instead you use the double curly markup like * `{{ expression }}` which is similar but less verbose. * - * It is preferrable to use `ngBind` instead of `{{ expression }}` when a template is momentarily - * displayed by the browser in its raw state before Angular compiles it. Since `ngBind` is an + * It is preferrable to use `ngBind` instead of `{{ expression }}` when a template is momentarily + * displayed by the browser in its raw state before Angular compiles it. Since `ngBind` is an * element attribute, it makes the bindings invisible to the user while the page is loading. * * An alternative solution to this problem would be using the @@ -125,7 +125,7 @@ var ngBindTemplateDirective = ['$interpolate', function($interpolate) { * ngSanitize.$sanitize $sanitize} service. To utilize this functionality, ensure that `$sanitize` * is available, for example, by including {@link ngSanitize} in your module's dependencies (not in * core Angular.) You may also bypass sanitization for values you know are safe. To do so, bind to - * an explicitly trusted value via {@link ng.$sce#trustAsHtml $sce.trustAsHtml}. See the example + * an explicitly trusted value via {@link ng.$sce#methods_trustAsHtml $sce.trustAsHtml}. See the example * under {@link ng.$sce#Example Strict Contextual Escaping (SCE)}. * * Note: If a `$sanitize` service is unavailable and the bound value isn't explicitly trusted, you diff --git a/src/ng/directive/ngInclude.js b/src/ng/directive/ngInclude.js index 2d164923..13b47234 100644 --- a/src/ng/directive/ngInclude.js +++ b/src/ng/directive/ngInclude.js @@ -9,10 +9,10 @@ * Fetches, compiles and includes an external HTML fragment. * * By default, the template URL is restricted to the same domain and protocol as the - * application document. This is done by calling {@link ng.$sce#getTrustedResourceUrl + * application document. This is done by calling {@link ng.$sce#methods_getTrustedResourceUrl * $sce.getTrustedResourceUrl} on it. To load templates from other domains or protocols - * you may either {@link ng.$sceDelegateProvider#resourceUrlWhitelist whitelist them} or - * {@link ng.$sce#trustAsResourceUrl wrap them} as trusted values. Refer to Angular's {@link + * you may either {@link ng.$sceDelegateProvider#methods_resourceUrlWhitelist whitelist them} or + * {@link ng.$sce#methods_trustAsResourceUrl wrap them} as trusted values. Refer to Angular's {@link * ng.$sce Strict Contextual Escaping}. * * In addition, the browser's diff --git a/src/ng/http.js b/src/ng/http.js index de8e6b6d..a09691e7 100644 --- a/src/ng/http.js +++ b/src/ng/http.js @@ -263,12 +263,12 @@ function $HttpProvider() { * * Complete list of shortcut methods: * - * - {@link ng.$http#get $http.get} - * - {@link ng.$http#head $http.head} - * - {@link ng.$http#post $http.post} - * - {@link ng.$http#put $http.put} - * - {@link ng.$http#delete $http.delete} - * - {@link ng.$http#jsonp $http.jsonp} + * - {@link ng.$http#methods_get $http.get} + * - {@link ng.$http#methods_head $http.head} + * - {@link ng.$http#methods_post $http.post} + * - {@link ng.$http#methods_put $http.put} + * - {@link ng.$http#methods_delete $http.delete} + * - {@link ng.$http#methods_jsonp $http.jsonp} * * * # Setting HTTP Headers diff --git a/src/ng/interpolate.js b/src/ng/interpolate.js index 7f16bd1d..d02a6a07 100644 --- a/src/ng/interpolate.js +++ b/src/ng/interpolate.js @@ -113,7 +113,7 @@ function $InterpolateProvider() { * embedded expression in order to return an interpolation function. Strings with no * embedded expression will return null for the interpolation function. * @param {string=} trustedContext when provided, the returned function passes the interpolated - * result through {@link ng.$sce#getTrusted $sce.getTrusted(interpolatedResult, + * result through {@link ng.$sce#methods_getTrusted $sce.getTrusted(interpolatedResult, * trustedContext)} before returning it. Refer to the {@link ng.$sce $sce} service that * provides Strict Contextual Escaping for details. * @returns {function(context)} an interpolation function which is used to compute the interpolated diff --git a/src/ng/interval.js b/src/ng/interval.js index e612f3e4..04493b11 100644 --- a/src/ng/interval.js +++ b/src/ng/interval.js @@ -21,7 +21,7 @@ function $IntervalProvider() { * number of iterations that have run. * To cancel an interval, call `$interval.cancel(promise)`. * - * In tests you can use {@link ngMock.$interval#flush `$interval.flush(millis)`} to + * In tests you can use {@link ngMock.$interval#methods_flush `$interval.flush(millis)`} to * move forward by `millis` milliseconds and trigger any functions scheduled to run in that * time. * @@ -30,7 +30,7 @@ function $IntervalProvider() { * @param {number=} [count=0] Number of times to repeat. If not set, or 0, will repeat * indefinitely. * @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise - * will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block. + * will invoke `fn` within the {@link ng.$rootScope.Scope#methods_$apply $apply} block. * @returns {promise} A promise which will be notified on each iteration. */ function interval(fn, delay, count, invokeApply) { diff --git a/src/ng/rootScope.js b/src/ng/rootScope.js index aa3a6f13..da4e30c2 100644 --- a/src/ng/rootScope.js +++ b/src/ng/rootScope.js @@ -85,7 +85,7 @@ function $RootScopeProvider(){ * @description * A root scope can be retrieved using the {@link ng.$rootScope $rootScope} key from the * {@link AUTO.$injector $injector}. Child scopes are created using the - * {@link ng.$rootScope.Scope#$new $new()} method. (Most scopes are created automatically when + * {@link ng.$rootScope.Scope#methods_$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. @@ -466,9 +466,9 @@ function $RootScopeProvider(){ * * Usually, you don't call `$digest()` directly in * {@link ng.directive:ngController controllers} or in - * {@link ng.$compileProvider#directive directives}. + * {@link ng.$compileProvider#methods_directive directives}. * Instead, you should call {@link ng.$rootScope.Scope#$apply $apply()} (typically from within a - * {@link ng.$compileProvider#directive directives}), which will force a `$digest()`. + * {@link ng.$compileProvider#methods_directive directives}), which will force a `$digest()`. * * If you want to be notified whenever `$digest()` is called, * you can register a `watchExpression` function with {@link ng.$rootScope.Scope#$watch $watch()} diff --git a/src/ng/sce.js b/src/ng/sce.js index 683081c9..8c4fde17 100644 --- a/src/ng/sce.js +++ b/src/ng/sce.js @@ -84,9 +84,9 @@ function adjustMatchers(matchers) { * can override it completely to change the behavior of `$sce`, the common case would * involve configuring the {@link ng.$sceDelegateProvider $sceDelegateProvider} instead by setting * your own whitelists and blacklists for trusting URLs used for loading AngularJS resources such as - * templates. Refer {@link ng.$sceDelegateProvider#resourceUrlWhitelist + * templates. Refer {@link ng.$sceDelegateProvider#methods_resourceUrlWhitelist * $sceDelegateProvider.resourceUrlWhitelist} and {@link - * ng.$sceDelegateProvider#resourceUrlBlacklist $sceDelegateProvider.resourceUrlBlacklist} + * ng.$sceDelegateProvider#methods_resourceUrlBlacklist $sceDelegateProvider.resourceUrlBlacklist} */ /** @@ -97,8 +97,8 @@ function adjustMatchers(matchers) { * The `$sceDelegateProvider` provider allows developers to configure the {@link ng.$sceDelegate * $sceDelegate} service. This allows one to get/set the whitelists and blacklists used to ensure * that the URLs used for sourcing Angular templates are safe. Refer {@link - * ng.$sceDelegateProvider#resourceUrlWhitelist $sceDelegateProvider.resourceUrlWhitelist} and - * {@link ng.$sceDelegateProvider#resourceUrlBlacklist $sceDelegateProvider.resourceUrlBlacklist} + * ng.$sceDelegateProvider#methods_resourceUrlWhitelist $sceDelegateProvider.resourceUrlWhitelist} and + * {@link ng.$sceDelegateProvider#methods_resourceUrlBlacklist $sceDelegateProvider.resourceUrlBlacklist} * * For the general details about this service in Angular, read the main page for {@link ng.$sce * Strict Contextual Escaping (SCE)}. @@ -312,16 +312,16 @@ function $SceDelegateProvider() { * @methodOf ng.$sceDelegate * * @description - * If the passed parameter had been returned by a prior call to {@link ng.$sceDelegate#trustAs + * If the passed parameter had been returned by a prior call to {@link ng.$sceDelegate#methods_trustAs * `$sceDelegate.trustAs`}, returns the value that had been passed to {@link - * ng.$sceDelegate#trustAs `$sceDelegate.trustAs`}. + * ng.$sceDelegate#methods_trustAs `$sceDelegate.trustAs`}. * * If the passed parameter is not a value that had been returned by {@link - * ng.$sceDelegate#trustAs `$sceDelegate.trustAs`}, returns it as-is. + * ng.$sceDelegate#methods_trustAs `$sceDelegate.trustAs`}, returns it as-is. * - * @param {*} value The result of a prior {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs`} + * @param {*} value The result of a prior {@link ng.$sceDelegate#methods_trustAs `$sceDelegate.trustAs`} * call or anything else. - * @returns {*} The value the was originally provided to {@link ng.$sceDelegate#trustAs + * @returns {*} The value the was originally provided to {@link ng.$sceDelegate#methods_trustAs * `$sceDelegate.trustAs`} if `value` is the result of such a call. Otherwise, returns `value` * unchanged. */ @@ -339,14 +339,14 @@ function $SceDelegateProvider() { * @methodOf ng.$sceDelegate * * @description - * Takes the result of a {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs`} call and returns the + * Takes the result of a {@link ng.$sceDelegate#methods_trustAs `$sceDelegate.trustAs`} call and returns the * originally supplied value if the queried context type is a supertype of the created type. If * this condition isn't satisfied, throws an exception. * * @param {string} type The kind of context in which this value is to be used. - * @param {*} maybeTrusted The result of a prior {@link ng.$sceDelegate#trustAs + * @param {*} maybeTrusted The result of a prior {@link ng.$sceDelegate#methods_trustAs * `$sceDelegate.trustAs`} call. - * @returns {*} The value the was originally provided to {@link ng.$sceDelegate#trustAs + * @returns {*} The value the was originally provided to {@link ng.$sceDelegate#methods_trustAs * `$sceDelegate.trustAs`} if valid in this context. Otherwise, throws an exception. */ function getTrusted(type, maybeTrusted) { @@ -448,20 +448,20 @@ function $SceDelegateProvider() { * allowing only the files in a specific directory to do this. Ensuring that the internal API * exposed by that code doesn't markup arbitrary values as safe then becomes a more manageable task. * - * In the case of AngularJS' SCE service, one uses {@link ng.$sce#trustAs $sce.trustAs} (and shorthand - * methods such as {@link ng.$sce#trustAsHtml $sce.trustAsHtml}, etc.) to obtain values that will be + * In the case of AngularJS' SCE service, one uses {@link ng.$sce#methods_trustAs $sce.trustAs} (and shorthand + * methods such as {@link ng.$sce#methods_trustAsHtml $sce.trustAsHtml}, etc.) to obtain values that will be * accepted by SCE / privileged contexts. * * * ## How does it work? * - * In privileged contexts, directives and code will bind to the result of {@link ng.$sce#getTrusted + * In privileged contexts, directives and code will bind to the result of {@link ng.$sce#methods_getTrusted * $sce.getTrusted(context, value)} rather than to the value directly. Directives use {@link - * ng.$sce#parse $sce.parseAs} rather than `$parse` to watch attribute bindings, which performs the - * {@link ng.$sce#getTrusted $sce.getTrusted} behind the scenes on non-constant literals. + * ng.$sce#methods_parse $sce.parseAs} rather than `$parse` to watch attribute bindings, which performs the + * {@link ng.$sce#methods_getTrusted $sce.getTrusted} behind the scenes on non-constant literals. * * As an example, {@link ng.directive:ngBindHtml ngBindHtml} uses {@link - * ng.$sce#parseAsHtml $sce.parseAsHtml(binding expression)}. Here's the actual code (slightly + * ng.$sce#methods_parseAsHtml $sce.parseAsHtml(binding expression)}. Here's the actual code (slightly * simplified): * * <pre class="prettyprint"> @@ -480,10 +480,10 @@ function $SceDelegateProvider() { * `templateUrl`'s specified by {@link guide/directive directives}. * * By default, Angular only loads templates from the same domain and protocol as the application - * document. This is done by calling {@link ng.$sce#getTrustedResourceUrl + * document. This is done by calling {@link ng.$sce#methods_getTrustedResourceUrl * $sce.getTrustedResourceUrl} on the template URL. To load templates from other domains and/or - * protocols, you may either either {@link ng.$sceDelegateProvider#resourceUrlWhitelist whitelist - * them} or {@link ng.$sce#trustAsResourceUrl wrap it} into a trusted value. + * protocols, you may either either {@link ng.$sceDelegateProvider#methods_resourceUrlWhitelist whitelist + * them} or {@link ng.$sce#methods_trustAsResourceUrl wrap it} into a trusted value. * * *Please note*: * The browser's @@ -503,20 +503,21 @@ function $SceDelegateProvider() { * `<div ng-html-bind-unsafe="'<b>implicitly trusted</b>'"></div>`) just works. * * Additionally, `a[href]` and `img[src]` automatically sanitize their URLs and do not pass them - * through {@link ng.$sce#getTrusted $sce.getTrusted}. SCE doesn't play a role here. + * through {@link ng.$sce#methods_getTrusted $sce.getTrusted}. SCE doesn't play a role here. * * The included {@link ng.$sceDelegate $sceDelegate} comes with sane defaults to allow you to load * templates in `ng-include` from your application's domain without having to even know about SCE. * It blocks loading templates from other domains or loading templates over http from an https * served document. You can change these by setting your own custom {@link - * ng.$sceDelegateProvider#resourceUrlWhitelist whitelists} and {@link - * ng.$sceDelegateProvider#resourceUrlBlacklist blacklists} for matching such URLs. + * ng.$sceDelegateProvider#methods_resourceUrlWhitelist whitelists} and {@link + * ng.$sceDelegateProvider#methods_resourceUrlBlacklist blacklists} for matching such URLs. * * This significantly reduces the overhead. It is far easier to pay the small overhead and have an * application that's secure and can be audited to verify that with much more ease than bolting * security onto an application later. * - * ## What trusted context types are supported?<a name="contexts"></a> + * <a name="contexts"></a> + * ## What trusted context types are supported? * * | Context | Notes | * |---------------------|----------------| @@ -526,7 +527,7 @@ function $SceDelegateProvider() { * | `$sce.RESOURCE_URL` | For URLs that are not only safe to follow as links, but whose contens are also safe to include in your application. Examples include `ng-include`, `src` / `ngSrc` bindings for tags other than `IMG` (e.g. `IFRAME`, `OBJECT`, etc.) <br><br>Note that `$sce.RESOURCE_URL` makes a stronger statement about the URL than `$sce.URL` does and therefore contexts requiring values trusted for `$sce.RESOURCE_URL` can be used anywhere that values trusted for `$sce.URL` are required. | * | `$sce.JS` | For JavaScript that is safe to execute in your application's context. Currently unused. Feel free to use it in your own directives. | * - * ## Format of items in {@link ng.$sceDelegateProvider#resourceUrlWhitelist resourceUrlWhitelist}/{@link ng.$sceDelegateProvider#resourceUrlBlacklist Blacklist} <a name="resourceUrlPatternItem"></a> + * ## Format of items in {@link ng.$sceDelegateProvider#methods_resourceUrlWhitelist resourceUrlWhitelist}/{@link ng.$sceDelegateProvider#methods_resourceUrlBlacklist Blacklist} <a name="resourceUrlPatternItem"></a> * * Each element in these arrays must be one of the following: * @@ -571,7 +572,7 @@ function $SceDelegateProvider() { * Closure library's [goog.string.regExpEscape(s)]( * http://docs.closure-library.googlecode.com/git/closure_goog_string_string.js.source.html#line962). * - * Refer {@link ng.$sceDelegateProvider#example $sceDelegateProvider} for an example. + * Refer {@link ng.$sceDelegateProvider $sceDelegateProvider} for an example. * * ## Show me an example using SCE. * @@ -770,7 +771,7 @@ function $SceProvider() { * @description * Converts Angular {@link guide/expression expression} into a function. This is like {@link * ng.$parse $parse} and is identical when the expression is a literal constant. Otherwise, it - * wraps the expression in a call to {@link ng.$sce#getTrusted $sce.getTrusted(*type*, + * wraps the expression in a call to {@link ng.$sce#methods_getTrusted $sce.getTrusted(*type*, * *result*)} * * @param {string} type The kind of SCE context in which this result will be used. @@ -799,7 +800,7 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Delegates to {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs`}. As such, returns an object + * Delegates to {@link ng.$sceDelegate#methods_trustAs `$sceDelegate.trustAs`}. As such, returns an object * that is trusted by angular for use in specified strict contextual escaping contexts (such as * ng-html-bind-unsafe, ng-include, any src attribute interpolation, any dom event binding * attribute interpolation such as for onclick, etc.) that uses the provided value. See * @@ -818,13 +819,13 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.trustAsHtml(value)` → {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.HTML, value)`} + * Shorthand method. `$sce.trustAsHtml(value)` → {@link ng.$sceDelegate#methods_trustAs `$sceDelegate.trustAs($sce.HTML, value)`} * * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedHtml + * @returns {*} An object that can be passed to {@link ng.$sce#methods_getTrustedHtml * $sce.getTrustedHtml(value)} to obtain the original value. (privileged directives * only accept expressions that are either literal constants or are the - * return value of {@link ng.$sce#trustAs $sce.trustAs}.) + * return value of {@link ng.$sce#methods_trustAs $sce.trustAs}.) */ /** @@ -833,13 +834,13 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.trustAsUrl(value)` → {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.URL, value)`} + * Shorthand method. `$sce.trustAsUrl(value)` → {@link ng.$sceDelegate#methods_trustAs `$sceDelegate.trustAs($sce.URL, value)`} * * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedUrl + * @returns {*} An object that can be passed to {@link ng.$sce#methods_getTrustedUrl * $sce.getTrustedUrl(value)} to obtain the original value. (privileged directives * only accept expressions that are either literal constants or are the - * return value of {@link ng.$sce#trustAs $sce.trustAs}.) + * return value of {@link ng.$sce#methods_trustAs $sce.trustAs}.) */ /** @@ -848,13 +849,13 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.trustAsResourceUrl(value)` → {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.RESOURCE_URL, value)`} + * Shorthand method. `$sce.trustAsResourceUrl(value)` → {@link ng.$sceDelegate#methods_trustAs `$sceDelegate.trustAs($sce.RESOURCE_URL, value)`} * * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedResourceUrl + * @returns {*} An object that can be passed to {@link ng.$sce#methods_getTrustedResourceUrl * $sce.getTrustedResourceUrl(value)} to obtain the original value. (privileged directives * only accept expressions that are either literal constants or are the return - * value of {@link ng.$sce#trustAs $sce.trustAs}.) + * value of {@link ng.$sce#methods_trustAs $sce.trustAs}.) */ /** @@ -863,13 +864,13 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.trustAsJs(value)` → {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.JS, value)`} + * Shorthand method. `$sce.trustAsJs(value)` → {@link ng.$sceDelegate#methods_trustAs `$sceDelegate.trustAs($sce.JS, value)`} * * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedJs + * @returns {*} An object that can be passed to {@link ng.$sce#methods_getTrustedJs * $sce.getTrustedJs(value)} to obtain the original value. (privileged directives * only accept expressions that are either literal constants or are the - * return value of {@link ng.$sce#trustAs $sce.trustAs}.) + * return value of {@link ng.$sce#methods_trustAs $sce.trustAs}.) */ /** @@ -878,14 +879,14 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Delegates to {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted`}. As such, takes - * the result of a {@link ng.$sce#trustAs `$sce.trustAs`}() call and returns the originally supplied + * Delegates to {@link ng.$sceDelegate#methods_getTrusted `$sceDelegate.getTrusted`}. As such, takes + * the result of a {@link ng.$sce#methods_trustAs `$sce.trustAs`}() call and returns the originally supplied * value if the queried context type is a supertype of the created type. If this condition * isn't satisfied, throws an exception. * * @param {string} type The kind of context in which this value is to be used. - * @param {*} maybeTrusted The result of a prior {@link ng.$sce#trustAs `$sce.trustAs`} call. - * @returns {*} The value the was originally provided to {@link ng.$sce#trustAs `$sce.trustAs`} if + * @param {*} maybeTrusted The result of a prior {@link ng.$sce#methods_trustAs `$sce.trustAs`} call. + * @returns {*} The value the was originally provided to {@link ng.$sce#methods_trustAs `$sce.trustAs`} if * valid in this context. Otherwise, throws an exception. */ @@ -895,7 +896,7 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.getTrustedHtml(value)` → {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.HTML, value)`} + * Shorthand method. `$sce.getTrustedHtml(value)` → {@link ng.$sceDelegate#methods_getTrusted `$sceDelegate.getTrusted($sce.HTML, value)`} * * @param {*} value The value to pass to `$sce.getTrusted`. * @returns {*} The return value of `$sce.getTrusted($sce.HTML, value)` @@ -907,7 +908,7 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.getTrustedCss(value)` → {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.CSS, value)`} + * Shorthand method. `$sce.getTrustedCss(value)` → {@link ng.$sceDelegate#methods_getTrusted `$sceDelegate.getTrusted($sce.CSS, value)`} * * @param {*} value The value to pass to `$sce.getTrusted`. * @returns {*} The return value of `$sce.getTrusted($sce.CSS, value)` @@ -919,7 +920,7 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.getTrustedUrl(value)` → {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.URL, value)`} + * Shorthand method. `$sce.getTrustedUrl(value)` → {@link ng.$sceDelegate#methods_getTrusted `$sceDelegate.getTrusted($sce.URL, value)`} * * @param {*} value The value to pass to `$sce.getTrusted`. * @returns {*} The return value of `$sce.getTrusted($sce.URL, value)` @@ -931,7 +932,7 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.getTrustedResourceUrl(value)` → {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.RESOURCE_URL, value)`} + * Shorthand method. `$sce.getTrustedResourceUrl(value)` → {@link ng.$sceDelegate#methods_getTrusted `$sceDelegate.getTrusted($sce.RESOURCE_URL, value)`} * * @param {*} value The value to pass to `$sceDelegate.getTrusted`. * @returns {*} The return value of `$sce.getTrusted($sce.RESOURCE_URL, value)` @@ -943,7 +944,7 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.getTrustedJs(value)` → {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.JS, value)`} + * Shorthand method. `$sce.getTrustedJs(value)` → {@link ng.$sceDelegate#methods_getTrusted `$sceDelegate.getTrusted($sce.JS, value)`} * * @param {*} value The value to pass to `$sce.getTrusted`. * @returns {*} The return value of `$sce.getTrusted($sce.JS, value)` @@ -955,7 +956,7 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.parseAsHtml(expression string)` → {@link ng.$sce#parse `$sce.parseAs($sce.HTML, value)`} + * Shorthand method. `$sce.parseAsHtml(expression string)` → {@link ng.$sce#methods_parse `$sce.parseAs($sce.HTML, value)`} * * @param {string} expression String expression to compile. * @returns {function(context, locals)} a function which represents the compiled expression: @@ -972,7 +973,7 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.parseAsCss(value)` → {@link ng.$sce#parse `$sce.parseAs($sce.CSS, value)`} + * Shorthand method. `$sce.parseAsCss(value)` → {@link ng.$sce#methods_parse `$sce.parseAs($sce.CSS, value)`} * * @param {string} expression String expression to compile. * @returns {function(context, locals)} a function which represents the compiled expression: @@ -989,7 +990,7 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.parseAsUrl(value)` → {@link ng.$sce#parse `$sce.parseAs($sce.URL, value)`} + * Shorthand method. `$sce.parseAsUrl(value)` → {@link ng.$sce#methods_parse `$sce.parseAs($sce.URL, value)`} * * @param {string} expression String expression to compile. * @returns {function(context, locals)} a function which represents the compiled expression: @@ -1006,7 +1007,7 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.parseAsResourceUrl(value)` → {@link ng.$sce#parse `$sce.parseAs($sce.RESOURCE_URL, value)`} + * Shorthand method. `$sce.parseAsResourceUrl(value)` → {@link ng.$sce#methods_parse `$sce.parseAs($sce.RESOURCE_URL, value)`} * * @param {string} expression String expression to compile. * @returns {function(context, locals)} a function which represents the compiled expression: @@ -1023,7 +1024,7 @@ function $SceProvider() { * @methodOf ng.$sce * * @description - * Shorthand method. `$sce.parseAsJs(value)` → {@link ng.$sce#parse `$sce.parseAs($sce.JS, value)`} + * Shorthand method. `$sce.parseAsJs(value)` → {@link ng.$sce#methods_parse `$sce.parseAs($sce.JS, value)`} * * @param {string} expression String expression to compile. * @returns {function(context, locals)} a function which represents the compiled expression: diff --git a/src/ng/timeout.js b/src/ng/timeout.js index 08086c90..51e627b9 100644 --- a/src/ng/timeout.js +++ b/src/ng/timeout.js @@ -28,7 +28,7 @@ function $TimeoutProvider() { * @param {function()} fn A function, whose execution should be delayed. * @param {number=} [delay=0] Delay in milliseconds. * @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise - * will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block. + * will invoke `fn` within the {@link ng.$rootScope.Scope#methods_$apply $apply} block. * @returns {Promise} Promise that will be resolved when the timeout is reached. The value this * promise will be resolved with is the return value of the `fn` function. * diff --git a/src/ngAnimate/animate.js b/src/ngAnimate/animate.js index 38f8bcb9..88a72073 100644 --- a/src/ngAnimate/animate.js +++ b/src/ngAnimate/animate.js @@ -20,13 +20,13 @@ * * | Directive | Supported Animations | * |---------------------------------------------------------- |----------------------------------------------------| - * | {@link ng.directive:ngRepeat#animations ngRepeat} | enter, leave and move | - * | {@link ngRoute.directive:ngView#animations ngView} | enter and leave | - * | {@link ng.directive:ngInclude#animations ngInclude} | enter and leave | - * | {@link ng.directive:ngSwitch#animations ngSwitch} | enter and leave | - * | {@link ng.directive:ngIf#animations ngIf} | enter and leave | - * | {@link ng.directive:ngClass#animations ngClass} | add and remove | - * | {@link ng.directive:ngShow#animations ngShow & ngHide} | add and remove (the ng-hide class value) | + * | {@link ng.directive:ngRepeat#usage_animations ngRepeat} | enter, leave and move | + * | {@link ngRoute.directive:ngView#usage_animations ngView} | enter and leave | + * | {@link ng.directive:ngInclude#usage_animations ngInclude} | enter and leave | + * | {@link ng.directive:ngSwitch#usage_animations ngSwitch} | enter and leave | + * | {@link ng.directive:ngIf#usage_animations ngIf} | enter and leave | + * | {@link ng.directive:ngClass#usage_animations ngClass} | add and remove | + * | {@link ng.directive:ngShow#usage_animations ngShow & ngHide} | add and remove (the ng-hide class value) | * * You can find out more information about animations upon visiting each directive page. * @@ -204,7 +204,7 @@ angular.module('ngAnimate', ['ng']) var rootAnimateState = {running:true}; $provide.decorator('$animate', ['$delegate', '$injector', '$sniffer', '$rootElement', '$timeout', '$rootScope', function($delegate, $injector, $sniffer, $rootElement, $timeout, $rootScope) { - + $rootElement.data(NG_ANIMATE_STATE, rootAnimateState); function lookup(name) { @@ -657,7 +657,7 @@ angular.module('ngAnimate', ['ng']) animationReflowQueue = []; animationTimer = null; lookupCache = {}; - }, 10, false); + }, 10, false); } function getElementAnimationDetails(element, cacheKey, onlyCheckTransition) { diff --git a/src/ngMock/angular-mocks.js b/src/ngMock/angular-mocks.js index 05551ea7..81124916 100644 --- a/src/ngMock/angular-mocks.js +++ b/src/ngMock/angular-mocks.js @@ -445,7 +445,7 @@ angular.mock.$LogProvider = function() { * @description * Mock implementation of the $interval service. * - * Use {@link ngMock.$interval#flush `$interval.flush(millis)`} to + * Use {@link ngMock.$interval#methods_flush `$interval.flush(millis)`} to * move forward by `millis` milliseconds and trigger any functions scheduled to run in that * time. * @@ -454,7 +454,7 @@ angular.mock.$LogProvider = function() { * @param {number=} [count=0] Number of times to repeat. If not set, or 0, will repeat * indefinitely. * @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise - * will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block. + * will invoke `fn` within the {@link ng.$rootScope.Scope#methods_$apply $apply} block. * @returns {promise} A promise which will be notified on each iteration. */ angular.mock.$IntervalProvider = function() { @@ -1951,7 +1951,7 @@ angular.mock.clearDataCache = function() { * * @param {...(string|Function|Object)} fns any number of modules which are represented as string * aliases or as anonymous module initialization functions. The modules are used to - * configure the injector. The 'ng' and 'ngMock' modules are automatically loaded. If an + * configure the injector. The 'ng' and 'ngMock' modules are automatically loaded. If an * object literal is passed they will be register as values in the module, the key being * the module name and the value being what is returned. */ @@ -1994,17 +1994,17 @@ angular.mock.clearDataCache = function() { * ## Resolving References (Underscore Wrapping) * Often, we would like to inject a reference once, in a `beforeEach()` block and reuse this * in multiple `it()` clauses. To be able to do this we must assign the reference to a variable - * that is declared in the scope of the `describe()` block. Since we would, most likely, want + * that is declared in the scope of the `describe()` block. Since we would, most likely, want * the variable to have the same name of the reference we have a problem, since the parameter * to the `inject()` function would hide the outer variable. * * To help with this, the injected parameters can, optionally, be enclosed with underscores. * These are ignored by the injector when the reference name is resolved. - * + * * For example, the parameter `_myService_` would be resolved as the reference `myService`. * Since it is available in the function body as _myService_, we can then assign it to a variable * defined in an outer scope. - * + * * ``` * // Defined out reference variable outside * var myService; @@ -2012,15 +2012,15 @@ angular.mock.clearDataCache = function() { * // Wrap the parameter in underscores * beforeEach( inject( function(_myService_){ * myService = _myService_; - * })); + * })); * * // Use myService in a series of tests. * it('makes use of myService', function() { * myService.doStuff(); * }); - * + * * ``` - * + * * See also {@link angular.mock.module angular.mock.module} * * ## Example @@ -2060,7 +2060,7 @@ angular.mock.clearDataCache = function() { * }); * * </pre> - * + * * @param {...Function} fns any number of functions which will be injected using the injector. */ window.inject = angular.mock.inject = function() { diff --git a/src/ngResource/resource.js b/src/ngResource/resource.js index 2498bdf3..504ea2c2 100644 --- a/src/ngResource/resource.js +++ b/src/ngResource/resource.js @@ -58,7 +58,7 @@ var $resourceMinErr = angular.$$minErr('$resource'); * * @param {Object.<Object>=} actions Hash with declaration of custom action that should extend the * default set of resource actions. The declaration should be created in the format of {@link - * ng.$http#Parameters $http.config}: + * ng.$http#usage_parameters $http.config}: * * {action1: {method:?, params:?, isArray:?, headers:?, ...}, * action2: {method:?, params:?, isArray:?, headers:?, ...}, diff --git a/src/ngRoute/routeParams.js b/src/ngRoute/routeParams.js index 4d306e89..e7b9da7a 100644 --- a/src/ngRoute/routeParams.js +++ b/src/ngRoute/routeParams.js @@ -14,7 +14,7 @@ ngRouteModule.provider('$routeParams', $RouteParamsProvider); * Requires the {@link ngRoute `ngRoute`} module to be installed. * * The route parameters are a combination of {@link ng.$location `$location`}'s - * {@link ng.$location#search `search()`} and {@link ng.$location#path `path()`}. + * {@link ng.$location#methods_search `search()`} and {@link ng.$location#methods_path `path()`}. * The `path` parameters are extracted when the {@link ngRoute.$route `$route`} path is matched. * * In case of parameter name collision, `path` params take precedence over `search` params. |
