aboutsummaryrefslogtreecommitdiffstats
path: root/src/ngMock/angular-mocks.js
diff options
context:
space:
mode:
authorSadaoui Abderrahim2014-02-21 03:21:54 -0800
committerPeter Bacon Darwin2014-02-21 13:48:01 +0000
commit7cd79b6f8f153d77f910cf5bdf73037223687aa2 (patch)
treed081a11d7e0580bd6c84885b351a0c49db450151 /src/ngMock/angular-mocks.js
parentfa5ca115ac0f73413f59bf49f911bf5363ba263e (diff)
downloadangular.js-7cd79b6f8f153d77f910cf5bdf73037223687aa2.tar.bz2
docs(ngMock.$interval): fix return description
Closes #6384
Diffstat (limited to 'src/ngMock/angular-mocks.js')
-rw-r--r--src/ngMock/angular-mocks.js9
1 files changed, 4 insertions, 5 deletions
diff --git a/src/ngMock/angular-mocks.js b/src/ngMock/angular-mocks.js
index 70fd2159..0fc13b23 100644
--- a/src/ngMock/angular-mocks.js
+++ b/src/ngMock/angular-mocks.js
@@ -494,13 +494,12 @@ angular.mock.$IntervalProvider = function() {
/**
* @ngdoc method
* @name $interval#cancel
- * @description
- *
- * Clears the interval.
*
- * @param {promise} The promise of the interval to cancel.
+ * @description
+ * Cancels a task associated with the `promise`.
*
- * @return {boolean}
+ * @param {number} promise A promise from calling the `$interval` function.
+ * @returns {boolean} Returns `true` if the task was successfully cancelled.
*/
$interval.cancel = function(promise) {
if(!promise) return false;