docs($location): update $location.search() jsdoc signature

jpsimons · IgorMinar · commit 894c7da2f3c8 · 2014-07-02T13:54:12.000-07:00
Closes angular#8050
diff --git a/src/ng/location.js b/src/ng/location.js
@@ -427,14 +427,17 @@ LocationHashbangInHtml5Url.prototype =
    * If the argument is a hash object containing an array of values, these values will be encoded
    * as duplicate search parameters in the url.
    *
-   * @param {(string|Array<string>)=} paramValue If `search` is a string, then `paramValue` will
-   * override only a single search property.
+   * @param {(string|Array<string>|boolean)=} paramValue If `search` is a string, then `paramValue`
+   * will override only a single search property.
    *
    * If `paramValue` is an array, it will override the property of the `search` component of
    * `$location` specified via the first argument.
    *
    * If `paramValue` is `null`, the property specified via the first argument will be deleted.
    *
+   * If `paramValue` is `true`, the property specified via the first argument will be added with no
+   * value nor trailing equal sign.
+   *
    * @return {Object} If called with no arguments returns the parsed `search` object. If called with
    * one or more arguments returns `$location` object itself.
    */

Original file line number	Diff line number	Diff line change
`@@ -427,14 +427,17 @@ LocationHashbangInHtml5Url.prototype =`
`427`	`427`	`* If the argument is a hash object containing an array of values, these values will be encoded`
`428`	`428`	`* as duplicate search parameters in the url.`
`429`	`429`	`*`
`430`		- * @param {(string\|Array<string>)=} paramValue If `search` is a string, then `paramValue` will
`431`		`- * override only a single search property.`
	`430`	+ * @param {(string\|Array<string>\|boolean)=} paramValue If `search` is a string, then `paramValue`
	`431`	`+ * will override only a single search property.`
`432`	`432`	`*`
`433`	`433`	* If `paramValue` is an array, it will override the property of the `search` component of
`434`	`434`	* `$location` specified via the first argument.
`435`	`435`	`*`
`436`	`436`	* If `paramValue` is `null`, the property specified via the first argument will be deleted.
`437`	`437`	`*`
	`438`	+ * If `paramValue` is `true`, the property specified via the first argument will be added with no
	`439`	`+ * value nor trailing equal sign.`
	`440`	`+ *`
`438`	`441`	* @return {Object} If called with no arguments returns the parsed `search` object. If called with
`439`	`442`	* one or more arguments returns `$location` object itself.
`440`	`443`	`*/`