aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorIgor Minar2011-11-30 14:13:15 -0500
committerIgor Minar2011-11-30 14:49:36 -0500
commitbaa7af0df099fd4bfabe1e90d275822d2558d69c (patch)
treeab00d1d587456248a3ead8d51209666ebd12e260 /src
parentf43c226c67ab64ee056615567e51f976c7637127 (diff)
downloadangular.js-baa7af0df099fd4bfabe1e90d275822d2558d69c.tar.bz2
docs($location): add docs for the $location.search setter
Diffstat (limited to 'src')
-rw-r--r--src/service/location.js5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/service/location.js b/src/service/location.js
index 735a592b..d0ae9de7 100644
--- a/src/service/location.js
+++ b/src/service/location.js
@@ -321,7 +321,10 @@ LocationUrl.prototype = {
*
* Change search part when called with parameter and return `$location`.
*
- * @param {string|object<string,string>=} search New search part - string or hash object
+ * @param {string|object<string,string>=} search New search params - string or hash object
+ * @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}
*/
search: function(search, paramValue) {