aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCaitlin Potter2014-02-18 12:25:08 -0500
committerCaitlin Potter2014-02-18 12:25:08 -0500
commit12e4d3ac4da3e7ea8d9be49764dbbc091a345bf7 (patch)
treef3b03ecc0b78c32b86652b2e7379369945faa347
parent4f937bda18bd577febcb29e3969fe72b400d1a61 (diff)
downloadangular.js-12e4d3ac4da3e7ea8d9be49764dbbc091a345bf7.tar.bz2
docs($q): fixup dgeni ngdoc annotations for $q methods
Just a tiny fixup, that's all. Closes #6317
-rw-r--r--src/ng/q.js16
1 files changed, 12 insertions, 4 deletions
diff --git a/src/ng/q.js b/src/ng/q.js
index 09448fd4..60711a7b 100644
--- a/src/ng/q.js
+++ b/src/ng/q.js
@@ -189,8 +189,10 @@ function $QProvider() {
function qFactory(nextTick, exceptionHandler) {
/**
- * @ngdoc
+ * @ngdoc method
* @name $q#defer
+ * @function
+ *
* @description
* Creates a `Deferred` object which represents a task which will finish in the future.
*
@@ -344,8 +346,10 @@ function qFactory(nextTick, exceptionHandler) {
/**
- * @ngdoc
+ * @ngdoc method
* @name $q#reject
+ * @function
+ *
* @description
* Creates a promise that is resolved as rejected with the specified `reason`. This api should be
* 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) {
/**
- * @ngdoc
+ * @ngdoc method
* @name $q#when
+ * @function
+ *
* @description
* Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise.
* 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) {
/**
- * @ngdoc
+ * @ngdoc method
* @name $q#all
+ * @function
+ *
* @description
* Combines multiple promises into a single promise that is resolved when all of the input
* promises are resolved.