docs(ngMock): document method ngMock.$interval#cancel()

I have been looking around and was not able to find any informations on how to clear the $interval
but reading the source code, sharing is caring!

Closes #6367

1 files changed, 11 insertions, 1 deletions

diff --git a/src/ngMock/angular-mocks.js b/src/ngMock/angular-mocks.js
index a9593e58..70fd2159 100644
--- a/src/ngMock/angular-mocks.js
+++ b/src/ngMock/angular-mocks.js
@@ -491,7 +491,17 @@ angular.mock.$IntervalProvider = function() {
       nextRepeatId++;
       return promise;
     };
-
+    /**
+     * @ngdoc method
+     * @name $interval#cancel
+     * @description
+     *
+     * Clears the interval.
+     *
+     * @param {promise} The promise of the interval to cancel.
+     *
+     * @return {boolean}
+     */
     $interval.cancel = function(promise) {
       if(!promise) return false;
       var fnIndex;