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

IgorMinar · IgorMinar · commit baa7af0df099 · 2011-11-30T14:49:36.000-05:00
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) {

Original file line number	Diff line number	Diff line change
`@@ -321,7 +321,10 @@ LocationUrl.prototype = {`
`321`	`321`	`*`
`322`	`322`	* Change search part when called with parameter and return `$location`.
`323`	`323`	`*`
`324`		`- * @param {string\|object<string,string>=} search New search part - string or hash object`
	`324`	`+ * @param {string\|object<string,string>=} search New search params - string or hash object`
	`325`	+ * @param {string=} paramValue If `search` is a string, then `paramValue` will override only a
	`326`	+ * single search parameter. If the value is `null`, the parameter will be deleted.
	`327`	`+ *`
`325`	`328`	`* @return {string}`
`326`	`329`	`*/`
`327`	`330`	`search: function(search, paramValue) {`