From 6082e2ad16d941a070fda16212d7a24e3dbb80ad Mon Sep 17 00:00:00 2001
From: Sadaoui Abderrahim
Date: Thu, 20 Feb 2014 06:03:32 -0800
Subject: 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
---
 src/ngMock/angular-mocks.js | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'src')

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;
-- 
cgit v1.2.3