From 5c5193946d196dda489d36ae1de865e72844e6f0 Mon Sep 17 00:00:00 2001
From: Wes Alvaro
Date: Sun, 14 Oct 2012 01:57:21 -0700
Subject: docs($timeout): set return type to Promise instead of *.

The cancel function accepts a Promise, but the timeout function
fails to specify returning a Promise.
---
 src/ng/timeout.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'src/ng/timeout.js')

diff --git a/src/ng/timeout.js b/src/ng/timeout.js
index 089b8110..e92bca69 100644
--- a/src/ng/timeout.js
+++ b/src/ng/timeout.js
@@ -29,7 +29,7 @@ function $TimeoutProvider() {
       * @param {number=} [delay=0] Delay in milliseconds.
       * @param {boolean=} [invokeApply=true] If set to false skips model dirty checking, otherwise
       *   will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block.
-      * @returns {*} Promise that will be resolved when the timeout is reached. The value this
+      * @returns {Promise} Promise that will be resolved when the timeout is reached. The value this
       *   promise will be resolved with is the return value of the `fn` function.
       */
     function timeout(fn, delay, invokeApply) {
-- 
cgit v1.2.3