aboutsummaryrefslogtreecommitdiffstats
path: root/src/ng/directive
diff options
context:
space:
mode:
authorPeter Bacon Darwin2014-02-07 20:40:35 +0000
committerPeter Bacon Darwin2014-02-16 19:03:41 +0000
commit2f7c57233ad2d578952dbba5c63ae8d50c1b487a (patch)
treec14f91ad8429dd4c0b93bbc89dbd37ac4382f1e2 /src/ng/directive
parent1192ae44f1d7f944719520f235e9f2ec895bdfd5 (diff)
downloadangular.js-2f7c57233ad2d578952dbba5c63ae8d50c1b487a.tar.bz2
docs(bike-shed-migration): let markdown deal with extenal links
It is problematic to use {@link} tags with external links because the markdown parser converts them to links for us before we parse the @links. This means that the following tag: ``` {@link http://www.google.com Google} ``` get converted to: ``` {@link <a href="http://www.google.com/"></a> Google} ``` Our {@link} parser then converts this to: ``` <a href="<a">&lt;</a>href="http://www.google.com/"></a> Google} ``` which is clearly a mess. The best solution is not to use {@link} tags for external links and just use the standard markdown syntax: ``` [Google](http://www.google.com) ``` In the long run, we could look into configuring or modifying `marked` not to convert these external links or we could provide a "pre-parser" processor that dealt with such links before `marked` gets its hands on it.
Diffstat (limited to 'src/ng/directive')
-rw-r--r--src/ng/directive/input.js2
-rw-r--r--src/ng/directive/ngIf.js2
-rw-r--r--src/ng/directive/ngInclude.js8
-rw-r--r--src/ng/directive/ngPluralize.js8
-rw-r--r--src/ng/directive/select.js2
5 files changed, 11 insertions, 11 deletions
diff --git a/src/ng/directive/input.js b/src/ng/directive/input.js
index 92c7d2c5..60cf6dfe 100644
--- a/src/ng/directive/input.js
+++ b/src/ng/directive/input.js
@@ -1209,7 +1209,7 @@ var NgModelController = ['$scope', '$exceptionHandler', '$attrs', '$element', '$
*
* For best practices on using `ngModel`, see:
*
- * - {@link https://github.com/angular/angular.js/wiki/Understanding-Scopes}
+ * - [https://github.com/angular/angular.js/wiki/Understanding-Scopes]
*
* For basic examples, how to use `ngModel`, see:
*
diff --git a/src/ng/directive/ngIf.js b/src/ng/directive/ngIf.js
index 9adb7080..2aaaf2dd 100644
--- a/src/ng/directive/ngIf.js
+++ b/src/ng/directive/ngIf.js
@@ -19,7 +19,7 @@
* Note that when an element is removed using `ngIf` its scope is destroyed and a new scope
* is created when the element is restored. The scope created within `ngIf` inherits from
* its parent scope using
- * {@link https://github.com/angular/angular.js/wiki/The-Nuances-of-Scope-Prototypal-Inheritance prototypal inheritance}.
+ * [prototypal inheritance](https://github.com/angular/angular.js/wiki/The-Nuances-of-Scope-Prototypal-Inheritance).
* An important implication of this is if `ngModel` is used within `ngIf` to bind to
* a javascript primitive defined in the parent scope. In this case any modifications made to the
* variable within the child scope will override (hide) the value in the parent scope.
diff --git a/src/ng/directive/ngInclude.js b/src/ng/directive/ngInclude.js
index 47bf742f..0258c9c5 100644
--- a/src/ng/directive/ngInclude.js
+++ b/src/ng/directive/ngInclude.js
@@ -12,13 +12,13 @@
* 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#methods_resourceUrlWhitelist whitelist them} or
- * {@link ng.$sce#methods_trustAsResourceUrl wrap them} as trusted values. Refer to Angular's {@link
+ * [wrap them](ng.$sce#methods_trustAsResourceUrl) as trusted values. Refer to Angular's {@link
* ng.$sce Strict Contextual Escaping}.
*
* In addition, the browser's
- * {@link https://code.google.com/p/browsersec/wiki/Part2#Same-origin_policy_for_XMLHttpRequest
- * Same Origin Policy} and {@link http://www.w3.org/TR/cors/ Cross-Origin Resource Sharing
- * (CORS)} policy may further restrict whether the template is successfully loaded.
+ * [Same Origin Policy](https://code.google.com/p/browsersec/wiki/Part2#Same-origin_policy_for_XMLHttpRequest)
+ * and [Cross-Origin Resource Sharing (CORS)](http://www.w3.org/TR/cors/)
+ * policy may further restrict whether the template is successfully loaded.
* For example, `ngInclude` won't work for cross-domain requests on all browsers and for `file://`
* access on some browsers.
*
diff --git a/src/ng/directive/ngPluralize.js b/src/ng/directive/ngPluralize.js
index a322b3b9..ea5f2779 100644
--- a/src/ng/directive/ngPluralize.js
+++ b/src/ng/directive/ngPluralize.js
@@ -11,13 +11,13 @@
* These rules are bundled with angular.js, but can be overridden
* (see {@link guide/i18n Angular i18n} dev guide). You configure ngPluralize directive
* by specifying the mappings between
- * {@link http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html
- * plural categories} and the strings to be displayed.
+ * [plural categories](http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html)
+ * and the strings to be displayed.
*
* # Plural categories and explicit number rules
* There are two
- * {@link http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html
- * plural categories} in Angular's default en-US locale: "one" and "other".
+ * [plural categories](http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html)
+ * in Angular's default en-US locale: "one" and "other".
*
* While a plural category may match many numbers (for example, in en-US locale, "other" can match
* any number that is not 1), an explicit number rule can only match one number. For example, the
diff --git a/src/ng/directive/select.js b/src/ng/directive/select.js
index faa9c7a7..cf0e4cae 100644
--- a/src/ng/directive/select.js
+++ b/src/ng/directive/select.js
@@ -21,7 +21,7 @@ var ngOptionsMinErr = minErr('ngOptions');
*
* <div class="alert alert-warning">
* **Note:** `ngModel` compares by reference, not value. This is important when binding to an
- * array of objects. See an example {@link http://jsfiddle.net/qWzTb/ in this jsfiddle}.
+ * array of objects. See an example [in this jsfiddle](http://jsfiddle.net/qWzTb/).
* </div>
*
* Optionally, a single hard-coded `<option>` element, with the value set to an empty string, can