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 | |
| parent | 28e72cbe6bfb874fa6a7f15769e5c83d66fb617f (diff) | |
| download | angular.js-a6978b201bbc1756b661dd968b3fb1b0d97f5033.tar.bz2 | |
make @param type and description non-optional
Diffstat (limited to 'src')
| -rw-r--r-- | src/Browser.js | 11 | ||||
| -rw-r--r-- | src/services.js | 15 |
2 files changed, 14 insertions, 12 deletions
diff --git a/src/Browser.js b/src/Browser.js index 2608f160..665f515f 100644 --- a/src/Browser.js +++ b/src/Browser.js @@ -128,7 +128,7 @@ function Browser(location, document, head, XHR, $log) { * @methodOf angular.service.$browser * * @param {number} interval How often should browser call poll functions (ms) - * @param {function} setTimeout + * @param {function} setTimeout Reference to a real or fake `setTimeout` function. * * @description * Configures the poller to run in the specified intervals, using the specified @@ -251,11 +251,12 @@ function Browser(location, document, head, XHR, $log) { * @ngdoc method * @name angular.service.$browser#hover * @methodOf angular.service.$browser - * - * @param {function(Object, boolean)} listener - * + * * @description - * Set hover listener - function that will be called when hover event occurs. + * Set hover listener. + * + * @param {function(Object, boolean)} listener Function that will be called when hover event + * occurs. */ self.hover = function(listener) { hoverListener = listener; }; 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]; |
