aboutsummaryrefslogtreecommitdiffstats
path: root/src/ng/location.js
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/location.js
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/location.js')
-rw-r--r--src/ng/location.js4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/ng/location.js b/src/ng/location.js
index 99783fc5..3a53ee1b 100644
--- a/src/ng/location.js
+++ b/src/ng/location.js
@@ -295,7 +295,7 @@ LocationHashbangInHtml5Url.prototype =
* This method is getter only.
*
* Return full url representation with all segments encoded according to rules specified in
- * {@link http://www.ietf.org/rfc/rfc3986.txt RFC 3986}.
+ * [RFC 3986](http://www.ietf.org/rfc/rfc3986.txt).
*
* @return {string} full url
*/
@@ -495,7 +495,7 @@ function locationGetterSetter(property, preprocess) {
*
* @description
* The $location service parses the URL in the browser address bar (based on the
- * {@link https://developer.mozilla.org/en/window.location window.location}) and makes the URL
+ * [window.location](https://developer.mozilla.org/en/window.location)) and makes the URL
* available to your application. Changes to the URL in the address bar are reflected into
* $location service and changes to $location are reflected into the browser address bar.
*