Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 7cd79b6

Browse files
SAFADpetebacondarwin
authored andcommitted
docs(ngMock.$interval): fix return description
Closes #6384
1 parent fa5ca11 commit 7cd79b6

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

src/ngMock/angular-mocks.js

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -494,13 +494,12 @@ angular.mock.$IntervalProvider = function() {
494494
/**
495495
* @ngdoc method
496496
* @name $interval#cancel
497-
* @description
498-
*
499-
* Clears the interval.
500497
*
501-
* @param {promise} The promise of the interval to cancel.
498+
* @description
499+
* Cancels a task associated with the `promise`.
502500
*
503-
* @return {boolean}
501+
* @param {number} promise A promise from calling the `$interval` function.
502+
* @returns {boolean} Returns `true` if the task was successfully cancelled.
504503
*/
505504
$interval.cancel = function(promise) {
506505
if(!promise) return false;

0 commit comments

Comments
 (0)