Hopiu/angular.js
1
0
Fork 0
mirror of https://github.com/Hopiu/angular.js.git synced 2026-05-16 02:33:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs($location): update paramValue description for search()

Browse source 
search() supports an array for paramValue, but this is not described in the docs.
This commit is contained in:
Freek Wielstra 2013-11-01 14:10:52 +01:00 committed by Jeff Cross
parent 9a828738cd
commit 8d4e3fdd31
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/ng/location.js
View file

@ -369,9 +369,10 @@ LocationHashbangInHtml5Url.prototype =
* @param {string|Object.<string>|Object.<Array.<string>>} search New search params - string or * @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 * hash object. Hash object may contain an array of values, which will be decoded as duplicates in
* the url. * the url.
* *
* @param {string=} paramValue If `search` is a string, then `paramValue` will override only a * @param {(string|Array<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. * 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 * @return {string} search
*/ */
@ -525,7 +526,7 @@ function $LocationProvider(){
return html5Mode; return html5Mode;
} }
}; };
/** /**
* @ngdoc event * @ngdoc event
* @name ng.$location#$locationChangeStart * @name ng.$location#$locationChangeStart
@ -541,14 +542,14 @@ function $LocationProvider(){
* @param {string} newUrl New URL * @param {string} newUrl New URL
* @param {string=} oldUrl URL that was before it was changed. * @param {string=} oldUrl URL that was before it was changed.
*/ */
/** /**
* @ngdoc event * @ngdoc event
* @name ng.$location#$locationChangeSuccess * @name ng.$location#$locationChangeSuccess
* @eventOf ng.$location * @eventOf ng.$location
* @eventType broadcast on root scope * @eventType broadcast on root scope
* @description * @description
* Broadcasted after a URL was changed. * Broadcasted after a URL was changed.
* *
* @param {Object} angularEvent Synthetic event object. * @param {Object} angularEvent Synthetic event object.
* @param {string} newUrl New URL * @param {string} newUrl New URL