diff options
| author | Igor Minar | 2010-11-17 14:46:49 -0800 |
|---|---|---|
| committer | Igor Minar | 2010-11-18 02:35:28 -0800 |
| commit | a6978b201bbc1756b661dd968b3fb1b0d97f5033 (patch) | |
| tree | f717b9de459dbe2d2402b1da3600c8af6a0f31c2 /src/services.js | |
| parent | 28e72cbe6bfb874fa6a7f15769e5c83d66fb617f (diff) | |
| download | angular.js-a6978b201bbc1756b661dd968b3fb1b0d97f5033.tar.bz2 | |
make @param type and description non-optional
Diffstat (limited to 'src/services.js')
| -rw-r--r-- | src/services.js | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/src/services.js b/src/services.js index f0a15c1b..5b09c663 100644 --- a/src/services.js +++ b/src/services.js @@ -621,7 +621,8 @@ angularServiceInject('$route', function(location) { * @methodOf angular.service.$route * * @param {string} path Route path (matched against $location.hash) - * @param {Object} params + * @param {Object} params Mapping information to be assigned to `$route.current` on route + * match. * @returns {Object} route object * * @description @@ -993,10 +994,10 @@ angularServiceInject('$cookieStore', function($store) { * @description * Returns the value of given cookie key * - * @param {string} key - * @returns {Object} Deserialized cookie value + * @param {string} key Id to use for lookup. + * @returns {Object} Deserialized cookie value. */ - get: function(/**string*/key) { + get: function(key) { return fromJson($store[key]); }, @@ -1008,8 +1009,8 @@ angularServiceInject('$cookieStore', function($store) { * @description * Sets a value for given cookie key * - * @param {string} key - * @param {Object} value + * @param {string} key Id for the `value`. + * @param {Object} value Value to be stored. */ put: function(key, value) { $store[key] = toJson(value); @@ -1023,7 +1024,7 @@ angularServiceInject('$cookieStore', function($store) { * @description * Remove given cookie * - * @param {string} key + * @param {string} key Id of the key-value pair to delete. */ remove: function(key) { delete $store[key]; |
