docs($location): add docs for the $location.search setter

angular · Nov 30, 2011 · baa7af0 · baa7af0
1 parent f43c226
commit baa7af0
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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) {