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/ng/sce.js | |
| 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/ng/sce.js')
| -rw-r--r-- | src/ng/sce.js | 111 | 
1 files changed, 56 insertions, 55 deletions
| 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: | 
