From 8d4e3fdd31eabadd87db38aa0590253e14791956 Mon Sep 17 00:00:00 2001 From: Freek Wielstra Date: Fri, 1 Nov 2013 14:10:52 +0100 Subject: docs($location): update paramValue description for search() search() supports an array for paramValue, but this is not described in the docs. --- src/ng/location.js | 13 +++++++------ 1 file 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.|Object.>} 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)=} 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 -- cgit v1.2.3