diff options
| author | Wes Alvaro | 2012-10-14 01:57:21 -0700 |
|---|---|---|
| committer | Igor Minar | 2012-11-11 11:32:00 +0100 |
| commit | 3dab93874d43b57c5f9daae39958fd64adb6bfde (patch) | |
| tree | b440c1b30a87a16a39564fc84ec7bb736f7e247c /src/ng/timeout.js | |
| parent | 7550f90a57f7a875d22de31293885e73abd76593 (diff) | |
| download | angular.js-3dab93874d43b57c5f9daae39958fd64adb6bfde.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.js | 2 |
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) { |
