aboutsummaryrefslogtreecommitdiffstats
path: root/src/ng/location.js
diff options
context:
space:
mode:
authorMisko Hevery2012-05-16 22:20:35 -0700
committerMisko Hevery2012-05-24 13:48:42 -0700
commitbbaf9a287022a9aa6675e4aab9894fe5bd041ad7 (patch)
treee9fb5f8a63f0879be0cb976b1fcb5cad46f99f05 /src/ng/location.js
parent7e70463da129dc7a668f234403bc530f562b9999 (diff)
downloadangular.js-bbaf9a287022a9aa6675e4aab9894fe5bd041ad7.tar.bz2
fix(docs): accept return in addition to returns
documentation used @return but parser expected @returns, which made the generated documentation incomplete.
Diffstat (limited to 'src/ng/location.js')
-rw-r--r--src/ng/location.js16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/ng/location.js b/src/ng/location.js
index 6d38d1ac..54abf6cb 100644
--- a/src/ng/location.js
+++ b/src/ng/location.js
@@ -214,7 +214,7 @@ LocationUrl.prototype = {
* Return full url representation with all segments encoded according to rules specified in
* {@link http://www.ietf.org/rfc/rfc3986.txt RFC 3986}.
*
- * @return {string}
+ * @return {string} full url
*/
absUrl: locationGetter('$$absUrl'),
@@ -231,7 +231,7 @@ LocationUrl.prototype = {
* Change path, search and hash, when called with parameter and return `$location`.
*
* @param {string=} url New url without base prefix (e.g. `/path?a=b#hash`)
- * @return {string}
+ * @return {string} url
*/
url: function(url, replace) {
if (isUndefined(url))
@@ -255,7 +255,7 @@ LocationUrl.prototype = {
*
* Return protocol of current url.
*
- * @return {string}
+ * @return {string} protocol of current url
*/
protocol: locationGetter('$$protocol'),
@@ -269,7 +269,7 @@ LocationUrl.prototype = {
*
* Return host of current url.
*
- * @return {string}
+ * @return {string} host of current url.
*/
host: locationGetter('$$host'),
@@ -283,7 +283,7 @@ LocationUrl.prototype = {
*
* Return port of current url.
*
- * @return {Number}
+ * @return {Number} port
*/
port: locationGetter('$$port'),
@@ -303,7 +303,7 @@ LocationUrl.prototype = {
* if it is missing.
*
* @param {string=} path New path
- * @return {string}
+ * @return {string} path
*/
path: locationGetterSetter('$$path', function(path) {
return path.charAt(0) == '/' ? path : '/' + path;
@@ -325,7 +325,7 @@ LocationUrl.prototype = {
* @param {string=} paramValue If `search` is a string, then `paramValue` will override only a
* single search parameter. If the value is `null`, the parameter will be deleted.
*
- * @return {string}
+ * @return {string} search
*/
search: function(search, paramValue) {
if (isUndefined(search))
@@ -358,7 +358,7 @@ LocationUrl.prototype = {
* Change hash fragment when called with parameter and return `$location`.
*
* @param {string=} hash New hash fragment
- * @return {string}
+ * @return {string} hash
*/
hash: locationGetterSetter('$$hash', identity),