aboutsummaryrefslogtreecommitdiffstats
path: root/src/ng/timeout.js
diff options
context:
space:
mode:
authorWes Alvaro2012-10-14 01:57:21 -0700
committerIgor Minar2012-11-11 11:31:51 +0100
commit5c5193946d196dda489d36ae1de865e72844e6f0 (patch)
tree123dd9c503882e20ee7c6ea36e00a155a537c3e1 /src/ng/timeout.js
parentffa6c5195fdc1c9a7d27e2cd20ac3f2e0ef46f74 (diff)
downloadangular.js-5c5193946d196dda489d36ae1de865e72844e6f0.tar.bz2
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.
Diffstat (limited to 'src/ng/timeout.js')
-rw-r--r--src/ng/timeout.js2
1 files changed, 1 insertions, 1 deletions
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) {