diff options
| author | Freek Wielstra | 2013-11-01 14:10:52 +0100 |
|---|---|---|
| committer | Jeff Cross | 2013-11-02 21:40:15 -0700 |
| commit | 8d4e3fdd31eabadd87db38aa0590253e14791956 (patch) | |
| tree | f6a3e62140d77d6532f541308c2d3ecd7bea90a5 /src | |
| parent | 9a828738cd2e959bc2a198989e96c8e416d28b71 (diff) | |
| download | angular.js-8d4e3fdd31eabadd87db38aa0590253e14791956.tar.bz2 | |
docs($location): update paramValue description for search()
search() supports an array for paramValue, but this is not described in the docs.
Diffstat (limited to 'src')
| -rw-r--r-- | src/ng/location.js | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/src/ng/location.js b/src/ng/location.js index e9cefe4e..6ec7d337 100644 --- a/src/ng/location.js +++ b/src/ng/location.js @@ -369,9 +369,10 @@ LocationHashbangInHtml5Url.prototype = * @param {string|Object.<string>|Object.<Array.<string>>} search New search params - string or * hash object. Hash object may contain an array of values, which will be decoded as duplicates in * the url. - * - * @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. + * + * @param {(string|Array<string>)=} paramValue If `search` is a string, then `paramValue` will override only a + * single search parameter. If `paramValue` is an array, it will set the parameter as a + * comma-separated value. If `paramValue` is `null`, the parameter will be deleted. * * @return {string} search */ @@ -525,7 +526,7 @@ function $LocationProvider(){ return html5Mode; } }; - + /** * @ngdoc event * @name ng.$location#$locationChangeStart @@ -541,14 +542,14 @@ function $LocationProvider(){ * @param {string} newUrl New URL * @param {string=} oldUrl URL that was before it was changed. */ - + /** * @ngdoc event * @name ng.$location#$locationChangeSuccess * @eventOf ng.$location * @eventType broadcast on root scope * @description - * Broadcasted after a URL was changed. + * Broadcasted after a URL was changed. * * @param {Object} angularEvent Synthetic event object. * @param {string} newUrl New URL |
