Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 9da8d63

Browse files
committed
docs($q): correct @ngdoc annotations for methods of $q
Closes #8782 Closes #8784
1 parent 0462b68 commit 9da8d63

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

src/ng/q.js

+15-11
Original file line numberDiff line numberDiff line change
@@ -250,9 +250,10 @@ function qFactory(nextTick, exceptionHandler) {
250250
}
251251

252252
/**
253-
* @ngdoc
253+
* @ngdoc method
254254
* @name ng.$q#defer
255-
* @methodOf ng.$q
255+
* @kind function
256+
*
256257
* @description
257258
* Creates a `Deferred` object which represents a task which will finish in the future.
258259
*
@@ -402,9 +403,10 @@ function qFactory(nextTick, exceptionHandler) {
402403
};
403404

404405
/**
405-
* @ngdoc
406-
* @name ng.$q#reject
407-
* @methodOf ng.$q
406+
* @ngdoc method
407+
* @name $q#reject
408+
* @kind function
409+
*
408410
* @description
409411
* Creates a promise that is resolved as rejected with the specified `reason`. This api should be
410412
* used to forward rejection in a chain of promises. If you are dealing with the last promise in
@@ -471,9 +473,10 @@ function qFactory(nextTick, exceptionHandler) {
471473
};
472474

473475
/**
474-
* @ngdoc
475-
* @name ng.$q#when
476-
* @methodOf ng.$q
476+
* @ngdoc method
477+
* @name $q#when
478+
* @kind function
479+
*
477480
* @description
478481
* Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise.
479482
* This is useful when you are dealing with an object that might or might not be a promise, or if
@@ -491,9 +494,10 @@ function qFactory(nextTick, exceptionHandler) {
491494
};
492495

493496
/**
494-
* @ngdoc
495-
* @name ng.$q#all
496-
* @methodOf ng.$q
497+
* @ngdoc method
498+
* @name $q#all
499+
* @kind function
500+
*
497501
* @description
498502
* Combines multiple promises into a single promise that is resolved when all of the input
499503
* promises are resolved.

0 commit comments

Comments
 (0)