From 7cd79b6f8f153d77f910cf5bdf73037223687aa2 Mon Sep 17 00:00:00 2001 From: Sadaoui Abderrahim Date: Fri, 21 Feb 2014 03:21:54 -0800 Subject: docs(ngMock.$interval): fix return description Closes #6384 --- src/ngMock/angular-mocks.js | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'src/ngMock/angular-mocks.js') 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; -- cgit v1.2.3