Skip to content

Commit 12e4d3a

Browse files
committed
docs($q): fixup dgeni ngdoc annotations for $q methods
Just a tiny fixup, that's all. Closes angular#6317
1 parent 4f937bd commit 12e4d3a

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

src/ng/q.js

+12-4
Original file line numberDiff line numberDiff line change
@@ -189,8 +189,10 @@ function $QProvider() {
189189
function qFactory(nextTick, exceptionHandler) {
190190

191191
/**
192-
* @ngdoc
192+
* @ngdoc method
193193
* @name $q#defer
194+
* @function
195+
*
194196
* @description
195197
* Creates a `Deferred` object which represents a task which will finish in the future.
196198
*
@@ -344,8 +346,10 @@ function qFactory(nextTick, exceptionHandler) {
344346

345347

346348
/**
347-
* @ngdoc
349+
* @ngdoc method
348350
* @name $q#reject
351+
* @function
352+
*
349353
* @description
350354
* Creates a promise that is resolved as rejected with the specified `reason`. This api should be
351355
* used to forward rejection in a chain of promises. If you are dealing with the last promise in
@@ -402,8 +406,10 @@ function qFactory(nextTick, exceptionHandler) {
402406

403407

404408
/**
405-
* @ngdoc
409+
* @ngdoc method
406410
* @name $q#when
411+
* @function
412+
*
407413
* @description
408414
* Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise.
409415
* This is useful when you are dealing with an object that might or might not be a promise, or if
@@ -472,8 +478,10 @@ function qFactory(nextTick, exceptionHandler) {
472478

473479

474480
/**
475-
* @ngdoc
481+
* @ngdoc method
476482
* @name $q#all
483+
* @function
484+
*
477485
* @description
478486
* Combines multiple promises into a single promise that is resolved when all of the input
479487
* promises are resolved.

0 commit comments

Comments
 (0)