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.
This commit is contained in:
Wes Alvaro 2012-10-14 01:57:21 -07:00 committed by Igor Minar
parent 7550f90a57
commit 3dab93874d

View file

@ -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) {