summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--lib/apply.js3
-rw-r--r--lib/applyEach.js3
-rw-r--r--lib/applyEachSeries.js5
-rw-r--r--lib/asyncify.js3
-rw-r--r--lib/auto.js3
-rw-r--r--lib/autoInject.js5
-rw-r--r--lib/cargo.js8
-rw-r--r--lib/compose.js3
-rw-r--r--lib/concat.js3
-rw-r--r--lib/concatSeries.js5
-rw-r--r--lib/constant.js3
-rw-r--r--lib/detect.js3
-rw-r--r--lib/detectLimit.js5
-rw-r--r--lib/detectSeries.js5
-rw-r--r--lib/dir.js3
-rw-r--r--lib/doDuring.js5
-rw-r--r--lib/doUntil.js5
-rw-r--r--lib/doWhilst.js5
-rw-r--r--lib/during.js5
-rw-r--r--lib/each.js3
-rw-r--r--lib/eachLimit.js5
-rw-r--r--lib/eachOf.js3
-rw-r--r--lib/eachOfLimit.js5
-rw-r--r--lib/eachOfSeries.js5
-rw-r--r--lib/eachSeries.js5
-rw-r--r--lib/ensureAsync.js3
-rw-r--r--lib/every.js3
-rw-r--r--lib/everyLimit.js5
-rw-r--r--lib/everySeries.js5
-rw-r--r--lib/filter.js3
-rw-r--r--lib/filterLimit.js5
-rw-r--r--lib/filterSeries.js5
-rw-r--r--lib/forever.js3
-rw-r--r--lib/index.js2
-rw-r--r--lib/iterator.js3
-rw-r--r--lib/log.js3
-rw-r--r--lib/map.js3
-rw-r--r--lib/mapLimit.js5
-rw-r--r--lib/mapSeries.js5
-rw-r--r--lib/mapValues.js3
-rw-r--r--lib/mapValuesLimit.js5
-rw-r--r--lib/mapValuesSeries.js5
-rw-r--r--lib/memoize.js3
-rw-r--r--lib/nextTick.js3
-rw-r--r--lib/parallel.js3
-rw-r--r--lib/parallelLimit.js5
-rw-r--r--lib/priorityQueue.js5
-rw-r--r--lib/queue.js6
-rw-r--r--lib/race.js3
-rw-r--r--lib/reduce.js3
-rw-r--r--lib/reduceRight.js5
-rw-r--r--lib/reflect.js3
-rw-r--r--lib/reflectAll.js5
-rw-r--r--lib/reject.js5
-rw-r--r--lib/rejectLimit.js5
-rw-r--r--lib/rejectSeries.js5
-rw-r--r--lib/retry.js3
-rw-r--r--lib/retryable.js5
-rw-r--r--lib/seq.js5
-rw-r--r--lib/series.js3
-rw-r--r--lib/setImmediate.js3
-rw-r--r--lib/some.js3
-rw-r--r--lib/someLimit.js5
-rw-r--r--lib/someSeries.js5
-rw-r--r--lib/sortBy.js3
-rw-r--r--lib/timeout.js3
-rw-r--r--lib/times.js5
-rw-r--r--lib/timesLimit.js5
-rw-r--r--lib/timesSeries.js5
-rw-r--r--lib/transform.js3
-rw-r--r--lib/unmemoize.js5
-rw-r--r--lib/until.js5
-rw-r--r--lib/waterfall.js3
-rw-r--r--lib/whilst.js3
-rw-r--r--package.json4
-rw-r--r--support/jsdoc.json21
76 files changed, 214 insertions, 114 deletions
diff --git a/lib/apply.js b/lib/apply.js
index 1cf7cb3..44f77e4 100644
--- a/lib/apply.js
+++ b/lib/apply.js
@@ -9,7 +9,8 @@ import rest from 'lodash/rest';
*
* @name apply
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Util
* @param {Function} function - The function you want to eventually apply all
* arguments to. Invokes with (arguments...).
diff --git a/lib/applyEach.js b/lib/applyEach.js
index 3337f57..c84430f 100644
--- a/lib/applyEach.js
+++ b/lib/applyEach.js
@@ -9,7 +9,8 @@ import map from './map';
*
* @name applyEach
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Control Flow
* @param {Array|Object} fns - A collection of asynchronous functions to all
* call with the same arguments
diff --git a/lib/applyEachSeries.js b/lib/applyEachSeries.js
index 0a01891..1181d94 100644
--- a/lib/applyEachSeries.js
+++ b/lib/applyEachSeries.js
@@ -6,8 +6,9 @@ import mapSeries from './mapSeries';
*
* @name applyEachSeries
* @static
- * @memberOf async
- * @see async.applyEach
+ * @memberOf module:async
+ * @method
+ * @see [async.applyEach]{@link module:async.applyEach}
* @category Control Flow
* @param {Array|Object} fns - A collection of asynchronous functions to all
* call with the same arguments
diff --git a/lib/asyncify.js b/lib/asyncify.js
index e3f6f87..f5a19f7 100644
--- a/lib/asyncify.js
+++ b/lib/asyncify.js
@@ -16,7 +16,8 @@ import initialParams from './internal/initialParams';
*
* @name asyncify
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @alias wrapSync
* @category Util
* @param {Function} func - The synchronous function to convert to an
diff --git a/lib/auto.js b/lib/auto.js
index bb8ee87..6b5c3d2 100644
--- a/lib/auto.js
+++ b/lib/auto.js
@@ -26,7 +26,8 @@ import onlyOnce from './internal/onlyOnce';
*
* @name auto
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Control Flow
* @param {Object} tasks - An object. Each of its properties is either a
* function or an array of requirements, with the function itself the last item
diff --git a/lib/autoInject.js b/lib/autoInject.js
index 40a250d..5805d56 100644
--- a/lib/autoInject.js
+++ b/lib/autoInject.js
@@ -26,8 +26,9 @@ function parseParams(func) {
*
* @name autoInject
* @static
- * @memberOf async
- * @see async.auto
+ * @memberOf module:async
+ * @method
+ * @see [async.auto]{@link module:async.applyEach}
* @category Control Flow
* @param {Object} tasks - An object, each of whose properties is a function of
* the form 'func([dependencies...], callback). The object's key of a property
diff --git a/lib/cargo.js b/lib/cargo.js
index 4bc5279..e17c8f5 100644
--- a/lib/cargo.js
+++ b/lib/cargo.js
@@ -4,6 +4,7 @@ import queue from './internal/queue';
* A cargo of tasks for the worker function to complete. Cargo inherits all of
* the same methods and event callbacks as {@link async.queue}.
* @typedef {Object} CargoObject
+ * @memberOf module:async
* @property {Function} length - A function returning the number of items
* waiting to be processed. Invoke like `cargo.length()`.
* @property {number} payload - An `integer` for determining how many tasks
@@ -43,8 +44,9 @@ import queue from './internal/queue';
*
* @name cargo
* @static
- * @memberOf async
- * @see async.queue
+ * @memberOf module:async
+ * @method
+ * @see [async.queue]{@link module:async.queue}
* @category Control Flow
* @param {Function} worker - An asynchronous function for processing an array
* of queued tasks, which must call its `callback(err)` argument when finished,
@@ -52,7 +54,7 @@ import queue from './internal/queue';
* @param {number} [payload=Infinity] - An optional `integer` for determining
* how many tasks should be processed per round; if omitted, the default is
* unlimited.
- * @returns {CargoObject} A cargo object to manage the tasks. Callbacks can
+ * @returns {module:async.CargoObject} A cargo object to manage the tasks. Callbacks can
* attached as certain properties to listen for specific events during the
* lifecycle of the cargo and inner queue.
* @example
diff --git a/lib/compose.js b/lib/compose.js
index 227c2ea..ba22878 100644
--- a/lib/compose.js
+++ b/lib/compose.js
@@ -12,7 +12,8 @@ var reverse = Array.prototype.reverse;
*
* @name compose
* @static
- * @memberOf async
+ * @memberof module:async
+ * @method
* @category Control Flow
* @param {...Function} functions - the asynchronous functions to compose
* @returns {Function} an asynchronous function that is the composed
diff --git a/lib/concat.js b/lib/concat.js
index be7410d..43d519f 100644
--- a/lib/concat.js
+++ b/lib/concat.js
@@ -10,7 +10,8 @@ import doParallel from './internal/doParallel';
*
* @name concat
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {Function} iteratee - A function to apply to each item in `coll`.
diff --git a/lib/concatSeries.js b/lib/concatSeries.js
index fef87b7..1272d73 100644
--- a/lib/concatSeries.js
+++ b/lib/concatSeries.js
@@ -6,8 +6,9 @@ import doSeries from './internal/doSeries';
*
* @name concatSeries
* @static
- * @memberOf async
- * @see async.concat
+ * @memberOf module:async
+ * @method
+ * @see [async.concat]{@link module:async.queue}
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {Function} iteratee - A function to apply to each item in `coll`.
diff --git a/lib/constant.js b/lib/constant.js
index a5e32fa..5cfc79c 100644
--- a/lib/constant.js
+++ b/lib/constant.js
@@ -8,7 +8,8 @@ import initialParams from './internal/initialParams';
*
* @name constant
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Util
* @param {...*} arguments... - Any number of arguments to automatically invoke
* callback with.
diff --git a/lib/detect.js b/lib/detect.js
index a4e246c..1fb4fe5 100644
--- a/lib/detect.js
+++ b/lib/detect.js
@@ -16,7 +16,8 @@ import findGetResult from './internal/findGetResult';
*
* @name detect
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @alias find
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/detectLimit.js b/lib/detectLimit.js
index 2e8ba7a..335add4 100644
--- a/lib/detectLimit.js
+++ b/lib/detectLimit.js
@@ -10,8 +10,9 @@ import findGetResult from './internal/findGetResult';
*
* @name detectLimit
* @static
- * @memberOf async
- * @see async.detect
+ * @memberOf module:async
+ * @method
+ * @see [async.detect]{@link module:async.detect}
* @alias findLimit
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/detectSeries.js b/lib/detectSeries.js
index 59b34a5..798199e 100644
--- a/lib/detectSeries.js
+++ b/lib/detectSeries.js
@@ -9,8 +9,9 @@ import findGetResult from './internal/findGetResult';
*
* @name detectSeries
* @static
- * @memberOf async
- * @see async.detect
+ * @memberOf module:async
+ * @method
+ * @see [async.detect]{@link module:async.detect}
* @alias findSeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/dir.js b/lib/dir.js
index 8b467af..035e4d2 100644
--- a/lib/dir.js
+++ b/lib/dir.js
@@ -9,7 +9,8 @@ import consoleFunc from './internal/consoleFunc';
*
* @name log
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Util
* @param {Function} function - The function you want to eventually apply all
* arguments to.
diff --git a/lib/doDuring.js b/lib/doDuring.js
index e018fe4..2a40c05 100644
--- a/lib/doDuring.js
+++ b/lib/doDuring.js
@@ -7,8 +7,9 @@ import during from './during';
* Also a version of {@link async.doWhilst} with asynchronous `test` function.
* @name doDuring
* @static
- * @memberOf async
- * @see async.during
+ * @memberOf module:async
+ * @method
+ * @see [async.during]{@link module:async.during}
* @category Control Flow
* @param {Function} fn - A function which is called each time `test` passes.
* The function is passed a `callback(err)`, which must be called once it has
diff --git a/lib/doUntil.js b/lib/doUntil.js
index 01f114c..ee9f257 100644
--- a/lib/doUntil.js
+++ b/lib/doUntil.js
@@ -6,8 +6,9 @@ import doWhilst from './doWhilst';
*
* @name doUntil
* @static
- * @memberOf async
- * @see async.doWhilst
+ * @memberOf module:async
+ * @method
+ * @see [async.doWhilst]{@link module:async.doWhilst}
* @category Control Flow
* @param {Function} fn - A function which is called each time `test` fails.
* The function is passed a `callback(err)`, which must be called once it has
diff --git a/lib/doWhilst.js b/lib/doWhilst.js
index 96c4664..655ede9 100644
--- a/lib/doWhilst.js
+++ b/lib/doWhilst.js
@@ -8,8 +8,9 @@ import whilst from './whilst';
*
* @name doWhilst
* @static
- * @memberOf async
- * @see async.whilst
+ * @memberOf module:async
+ * @method
+ * @see [async.whilst]{@link module:async.whilst}
* @category Control Flow
* @param {Function} fn - A function which is called each time `test` passes.
* The function is passed a `callback(err)`, which must be called once it has
diff --git a/lib/during.js b/lib/during.js
index 1013bc8..943b3dd 100644
--- a/lib/during.js
+++ b/lib/during.js
@@ -9,8 +9,9 @@ import rest from 'lodash/rest';
*
* @name during
* @static
- * @memberOf async
- * @see async.whilst
+ * @memberOf module:async
+ * @method
+ * @see [async.whilst]{@link module:async.whilst}
* @category Control Flow
* @param {Function} test - asynchronous truth test to perform before each
* execution of `fn`. Invoked with (callback).
diff --git a/lib/each.js b/lib/each.js
index 90ba3ee..e0a5e1c 100644
--- a/lib/each.js
+++ b/lib/each.js
@@ -13,7 +13,8 @@ import doLimit from './internal/doLimit';
*
* @name each
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @alias forEach
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/eachLimit.js b/lib/eachLimit.js
index d5f200c..544157a 100644
--- a/lib/eachLimit.js
+++ b/lib/eachLimit.js
@@ -6,8 +6,9 @@ import withoutIndex from './internal/withoutIndex';
*
* @name eachLimit
* @static
- * @memberOf async
- * @see async.each
+ * @memberOf module:async
+ * @method
+ * @see [async.each]{@link module:async.each}
* @alias forEachLimit
* @category Collection
* @param {Array|Object} coll - A colleciton to iterate over.
diff --git a/lib/eachOf.js b/lib/eachOf.js
index 1defd47..e621007 100644
--- a/lib/eachOf.js
+++ b/lib/eachOf.js
@@ -7,7 +7,8 @@ import doLimit from './internal/doLimit';
*
* @name eachOf
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @alias forEachOf
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/eachOfLimit.js b/lib/eachOfLimit.js
index 5810f8f..767cedd 100644
--- a/lib/eachOfLimit.js
+++ b/lib/eachOfLimit.js
@@ -6,8 +6,9 @@ import _eachOfLimit from './internal/eachOfLimit';
*
* @name eachOfLimit
* @static
- * @memberOf async
- * @see async.eachOf
+ * @memberOf module:async
+ * @method
+ * @see [async.eachOf]{@link module:async.eachOf}
* @alias forEachOfLimit
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/eachOfSeries.js b/lib/eachOfSeries.js
index dee4838..475ae03 100644
--- a/lib/eachOfSeries.js
+++ b/lib/eachOfSeries.js
@@ -6,8 +6,9 @@ import doLimit from './internal/doLimit';
*
* @name eachOfSeries
* @static
- * @memberOf async
- * @see async.eachOf
+ * @memberOf module:async
+ * @method
+ * @see [async.eachOf]{@link module:async.eachOf}
* @alias forEachOfSeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/eachSeries.js b/lib/eachSeries.js
index 3d8af62..8a5465a 100644
--- a/lib/eachSeries.js
+++ b/lib/eachSeries.js
@@ -6,8 +6,9 @@ import doLimit from './internal/doLimit';
*
* @name eachSeries
* @static
- * @memberOf async
- * @see async.each
+ * @memberOf module:async
+ * @method
+ * @see [async.each]{@link module:async.each}
* @alias forEachSeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/ensureAsync.js b/lib/ensureAsync.js
index 55d59fe..bd0b29a 100644
--- a/lib/ensureAsync.js
+++ b/lib/ensureAsync.js
@@ -11,7 +11,8 @@ import initialParams from './internal/initialParams';
*
* @name ensureAsync
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Util
* @param {Function} fn - an async function, one that expects a node-style
* callback as its last argument.
diff --git a/lib/every.js b/lib/every.js
index a2377ea..c28d6b0 100644
--- a/lib/every.js
+++ b/lib/every.js
@@ -7,7 +7,8 @@ import doLimit from './internal/doLimit';
*
* @name every
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @alias all
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/everyLimit.js b/lib/everyLimit.js
index 7d2b042..f06a14d 100644
--- a/lib/everyLimit.js
+++ b/lib/everyLimit.js
@@ -7,8 +7,9 @@ import notId from './internal/notId';
*
* @name everyLimit
* @static
- * @memberOf async
- * @see async.every
+ * @memberOf module:async
+ * @method
+ * @see [async.every]{@link module:async.every}
* @alias allLimit
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/everySeries.js b/lib/everySeries.js
index 24ee4ed..7b99d6d 100644
--- a/lib/everySeries.js
+++ b/lib/everySeries.js
@@ -6,8 +6,9 @@ import doLimit from './internal/doLimit';
*
* @name everySeries
* @static
- * @memberOf async
- * @see async.every
+ * @memberOf module:async
+ * @method
+ * @see [async.every]{@link module:async.every}
* @alias allSeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/filter.js b/lib/filter.js
index 7f48ae1..9dce1be 100644
--- a/lib/filter.js
+++ b/lib/filter.js
@@ -8,7 +8,8 @@ import doLimit from './internal/doLimit';
*
* @name filter
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @alias select
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/filterLimit.js b/lib/filterLimit.js
index 615b170..7504608 100644
--- a/lib/filterLimit.js
+++ b/lib/filterLimit.js
@@ -7,8 +7,9 @@ import doParallelLimit from './internal/doParallelLimit';
*
* @name filterLimit
* @static
- * @memberOf async
- * @see async.filter
+ * @memberOf module:async
+ * @method
+ * @see [async.filter]{@link module:async.filter}
* @alias selectLimit
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/filterSeries.js b/lib/filterSeries.js
index 6fde694..a170ce6 100644
--- a/lib/filterSeries.js
+++ b/lib/filterSeries.js
@@ -6,8 +6,9 @@ import doLimit from './internal/doLimit';
*
* @name filterSeries
* @static
- * @memberOf async
- * @see async.filter
+ * @memberOf module:async
+ * @method
+ * @see [async.filter]{@link module:async.filter}
* @alias selectSeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/forever.js b/lib/forever.js
index 4708d21..44eb19c 100644
--- a/lib/forever.js
+++ b/lib/forever.js
@@ -13,7 +13,8 @@ import ensureAsync from './ensureAsync';
*
* @name forever
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Control Flow
* @param {Function} fn - a function to call repeatedly. Invoked with (next).
* @param {Function} [errback] - when `fn` passes an error to it's callback,
diff --git a/lib/index.js b/lib/index.js
index a8a3ab8..091f657 100644
--- a/lib/index.js
+++ b/lib/index.js
@@ -3,7 +3,7 @@
* for working with asynchronous JavaScript. Although originally designed for
* use with [Node.js](http://nodejs.org) and installable via
* `npm install --save async`, it can also be used directly in the browser.
- * @namespace async
+ * @module async
*/
import applyEach from './applyEach';
import applyEachSeries from './applyEachSeries';
diff --git a/lib/iterator.js b/lib/iterator.js
index b37c18a..49206ff 100644
--- a/lib/iterator.js
+++ b/lib/iterator.js
@@ -8,7 +8,8 @@
*
* @name iterator
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Control Flow
* @param {Array} tasks - An array of functions to run.
* @returns The next function to run in the series.
diff --git a/lib/log.js b/lib/log.js
index b18733e..4386450 100644
--- a/lib/log.js
+++ b/lib/log.js
@@ -8,7 +8,8 @@ import consoleFunc from './internal/consoleFunc';
*
* @name log
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Util
* @param {Function} function - The function you want to eventually apply all
* arguments to.
diff --git a/lib/map.js b/lib/map.js
index 19642c8..96c1e80 100644
--- a/lib/map.js
+++ b/lib/map.js
@@ -20,7 +20,8 @@ import doLimit from './internal/doLimit';
*
* @name map
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {Function} iteratee - A function to apply to each item in `coll`.
diff --git a/lib/mapLimit.js b/lib/mapLimit.js
index 0cf049b..b773d58 100644
--- a/lib/mapLimit.js
+++ b/lib/mapLimit.js
@@ -6,8 +6,9 @@ import map from './internal/map';
*
* @name mapLimit
* @static
- * @memberOf async
- * @see async.map
+ * @memberOf module:async
+ * @method
+ * @see [async.map]{@link module:async.map}
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {number} limit - The maximum number of async operations at a time.
diff --git a/lib/mapSeries.js b/lib/mapSeries.js
index c241bef..abbeb0a 100644
--- a/lib/mapSeries.js
+++ b/lib/mapSeries.js
@@ -6,8 +6,9 @@ import doLimit from './internal/doLimit';
*
* @name mapSeries
* @static
- * @memberOf async
- * @see async.map
+ * @memberOf module:async
+ * @method
+ * @see [async.map]{@link module:async.map}
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {Function} iteratee - A function to apply to each item in `coll`.
diff --git a/lib/mapValues.js b/lib/mapValues.js
index 83ffc43..a1f7967 100644
--- a/lib/mapValues.js
+++ b/lib/mapValues.js
@@ -17,7 +17,8 @@ import doLimit from './internal/doLimit';
*
* @name mapValues
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Collection
* @param {Object} obj - A collection to iterate over.
* @param {Function} iteratee - A function to apply to each value and key in
diff --git a/lib/mapValuesLimit.js b/lib/mapValuesLimit.js
index 762b871..9d2333c 100644
--- a/lib/mapValuesLimit.js
+++ b/lib/mapValuesLimit.js
@@ -6,8 +6,9 @@ import eachOfLimit from './eachOfLimit';
*
* @name mapValuesLimit
* @static
- * @memberOf async
- * @see async.mapValues
+ * @memberOf module:async
+ * @method
+ * @see [async.mapValues]{@link module:async.mapValues}
* @category Collection
* @param {Object} obj - A collection to iterate over.
* @param {number} limit - The maximum number of async operations at a time.
diff --git a/lib/mapValuesSeries.js b/lib/mapValuesSeries.js
index 163d474..35f1c95 100644
--- a/lib/mapValuesSeries.js
+++ b/lib/mapValuesSeries.js
@@ -6,8 +6,9 @@ import doLimit from './internal/doLimit';
*
* @name mapValuesSeries
* @static
- * @memberOf async
- * @see async.mapValues
+ * @memberOf module:async
+ * @method
+ * @see [async.mapValues]{@link module:async.mapValues}
* @category Collection
* @param {Object} obj - A collection to iterate over.
* @param {Function} iteratee - A function to apply to each value in `obj`.
diff --git a/lib/memoize.js b/lib/memoize.js
index 5b06cff..7cb22c2 100644
--- a/lib/memoize.js
+++ b/lib/memoize.js
@@ -24,7 +24,8 @@ function has(obj, key) {
*
* @name memoize
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Util
* @param {Function} fn - The function to proxy and cache results from.
* @param {Function} hasher - An optional function for generating a custom hash
diff --git a/lib/nextTick.js b/lib/nextTick.js
index 9a1d6a0..f6c9fca 100644
--- a/lib/nextTick.js
+++ b/lib/nextTick.js
@@ -12,7 +12,8 @@ import { hasNextTick, hasSetImmediate, fallback, wrap } from './internal/setImm
*
* @name nextTick
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @alias setImmediate
* @category Util
* @param {Function} callback - The function to call on a later loop around
diff --git a/lib/parallel.js b/lib/parallel.js
index 5a01b5f..e61e337 100644
--- a/lib/parallel.js
+++ b/lib/parallel.js
@@ -21,7 +21,8 @@ import doLimit from './internal/doLimit';
*
* @name parallel
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Control Flow
* @param {Array|Object} tasks - A collection containing functions to run.
* Each function is passed a `callback(err, result)` which it must call on
diff --git a/lib/parallelLimit.js b/lib/parallelLimit.js
index 2eb8b2f..d313bb8 100644
--- a/lib/parallelLimit.js
+++ b/lib/parallelLimit.js
@@ -7,8 +7,9 @@ import parallel from './internal/parallel';
*
* @name parallel
* @static
- * @memberOf async
- * @see async.parallel
+ * @memberOf module:async
+ * @method
+ * @see [async.parallel]{@link module:async.parallel}
* @category Control Flow
* @param {Array|Collection} tasks - A collection containing functions to run.
* Each function is passed a `callback(err, result)` which it must call on
diff --git a/lib/priorityQueue.js b/lib/priorityQueue.js
index 36cacaf..6fa02ce 100644
--- a/lib/priorityQueue.js
+++ b/lib/priorityQueue.js
@@ -12,8 +12,9 @@ import queue from './queue';
*
* @name priorityQueue
* @static
- * @memberOf async
- * @see async.queue
+ * @memberOf module:async
+ * @method
+ * @see [async.queue]{@link module:async.queue}
* @category Control Flow
* @param {Function} worker - An asynchronous function for processing a queued
* task, which must call its `callback(err)` argument when finished, with an
diff --git a/lib/queue.js b/lib/queue.js
index db1c239..799cc97 100644
--- a/lib/queue.js
+++ b/lib/queue.js
@@ -3,6 +3,7 @@ import queue from './internal/queue';
/**
* A queue of tasks for the worker function to complete.
* @typedef {Object} QueueObject
+ * @memberOf module:async
* @property {Function} length - a function returning the number of items
* waiting to be processed. Invoke with `queue.length()`.
* @property {Function} started - a function returning whether or not any
@@ -54,7 +55,8 @@ import queue from './internal/queue';
*
* @name queue
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Control Flow
* @param {Function} worker - An asynchronous function for processing a queued
* task, which must call its `callback(err)` argument when finished, with an
@@ -64,7 +66,7 @@ import queue from './internal/queue';
* @param {number} [concurrency=1] - An `integer` for determining how many
* `worker` functions should be run in parallel. If omitted, the concurrency
* defaults to `1`. If the concurrency is `0`, an error is thrown.
- * @returns {QueueObject} A queue object to manage the tasks. Callbacks can
+ * @returns {module:async.QueueObject} A queue object to manage the tasks. Callbacks can
* attached as certain properties to listen for specific events during the
* lifecycle of the queue.
* @example
diff --git a/lib/race.js b/lib/race.js
index 2b8ad39..d656701 100644
--- a/lib/race.js
+++ b/lib/race.js
@@ -11,7 +11,8 @@ import once from './internal/once';
*
* @name race
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Control Flow
* @param {Array} tasks - An array containing functions to run. Each function
* is passed a `callback(err, result)` which it must call on completion with an
diff --git a/lib/reduce.js b/lib/reduce.js
index 8f529a0..7754f33 100644
--- a/lib/reduce.js
+++ b/lib/reduce.js
@@ -13,7 +13,8 @@ import eachOfSeries from './eachOfSeries';
*
* @name reduce
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @alias inject
* @alias foldl
* @category Collection
diff --git a/lib/reduceRight.js b/lib/reduceRight.js
index fda0505..d1ffa55 100644
--- a/lib/reduceRight.js
+++ b/lib/reduceRight.js
@@ -7,8 +7,9 @@ var slice = Array.prototype.slice;
*
* @name reduceRight
* @static
- * @memberOf async
- * @see async.reduce
+ * @memberOf module:async
+ * @method
+ * @see [async.reduce]{@link module:async.reduce}
* @alias foldr
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/reflect.js b/lib/reflect.js
index 63adefb..e650461 100644
--- a/lib/reflect.js
+++ b/lib/reflect.js
@@ -9,7 +9,8 @@ import rest from 'lodash/rest';
*
* @name reflect
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Util
* @param {Function} fn - The function you want to wrap
* @returns {Function} - A function that always passes null to it's callback as
diff --git a/lib/reflectAll.js b/lib/reflectAll.js
index ac9ea06..6167e6c 100644
--- a/lib/reflectAll.js
+++ b/lib/reflectAll.js
@@ -5,8 +5,9 @@ import reflect from './reflect';
*
* @name reflectAll
* @static
- * @memberOf async
- * @see async.reflect
+ * @memberOf module:async
+ * @method
+ * @see [async.reflect]{@link module:async.reflect}
* @category Util
* @param {Array} tasks - The array of functions to wrap in `async.reflect`.
* @returns {Array} Returns an array of functions, each function wrapped in
diff --git a/lib/reject.js b/lib/reject.js
index f4c7a45..fb7ad9d 100644
--- a/lib/reject.js
+++ b/lib/reject.js
@@ -6,8 +6,9 @@ import doLimit from './internal/doLimit';
*
* @name reject
* @static
- * @memberOf async
- * @see async.filter
+ * @memberOf module:async
+ * @method
+ * @see [async.filter]{@link module:async.filter}
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {Function} iteratee - A truth test to apply to each item in `coll`.
diff --git a/lib/rejectLimit.js b/lib/rejectLimit.js
index a8e2082..5942428 100644
--- a/lib/rejectLimit.js
+++ b/lib/rejectLimit.js
@@ -7,8 +7,9 @@ import doParallelLimit from './internal/doParallelLimit';
*
* @name rejectLimit
* @static
- * @memberOf async
- * @see async.reject
+ * @memberOf module:async
+ * @method
+ * @see [async.reject]{@link module:async.reject}
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {number} limit - The maximum number of async operations at a time.
diff --git a/lib/rejectSeries.js b/lib/rejectSeries.js
index 8fc7a41..6a3016a 100644
--- a/lib/rejectSeries.js
+++ b/lib/rejectSeries.js
@@ -6,8 +6,9 @@ import doLimit from './internal/doLimit';
*
* @name rejectSeries
* @static
- * @memberOf async
- * @see async.reject
+ * @memberOf module:async
+ * @method
+ * @see [async.reject]{@link module:async.reject}
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {Function} iteratee - A truth test to apply to each item in `coll`.
diff --git a/lib/retry.js b/lib/retry.js
index 69c3eb3..6a98b99 100644
--- a/lib/retry.js
+++ b/lib/retry.js
@@ -10,7 +10,8 @@ import constant from 'lodash/constant';
*
* @name retry
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Control Flow
* @param {Object|number} [opts = {times: 5, interval: 0}| 5] - Can be either an
* object with `times` and `interval` or a number.
diff --git a/lib/retryable.js b/lib/retryable.js
index b9c0fbb..45ef5ac 100644
--- a/lib/retryable.js
+++ b/lib/retryable.js
@@ -7,8 +7,9 @@ import initialParams from './internal/initialParams';
*
* @name retryable
* @static
- * @memberOf async
- * @see async.retry
+ * @memberOf module:async
+ * @method
+ * @see [async.retry]{@link module:async.retry}
* @category Control Flow
* @param {Object|number} [opts = {times: 5, interval: 0}| 5] - optional
* options, exactly the same as from `retry`
diff --git a/lib/seq.js b/lib/seq.js
index 4b3e49c..3048beb 100644
--- a/lib/seq.js
+++ b/lib/seq.js
@@ -11,8 +11,9 @@ import reduce from './reduce';
*
* @name seq
* @static
- * @memberOf async
- * @see async.compose
+ * @memberOf module:async
+ * @method
+ * @see [async.compose]{@link module:async.compose}
* @category Control Flow
* @param {...Function} functions - the asynchronous functions to compose
* @returns {Function} a function that composes the `functions` in order
diff --git a/lib/series.js b/lib/series.js
index 3345519..713c839 100644
--- a/lib/series.js
+++ b/lib/series.js
@@ -24,7 +24,8 @@ import eachOfSeries from './eachOfSeries';
*
* @name series
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Control Flow
* @param {Array|Object} tasks - A collection containing functions to run, each
* function is passed a `callback(err, result)` it must call on completion with
diff --git a/lib/setImmediate.js b/lib/setImmediate.js
index 68f94d7..7485b40 100644
--- a/lib/setImmediate.js
+++ b/lib/setImmediate.js
@@ -10,7 +10,8 @@ import setImmediate from './internal/setImmediate';
*
* @name setImmediate
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @alias nextTick
* @category Util
* @param {Function} callback - The function to call on a later loop around
diff --git a/lib/some.js b/lib/some.js
index 4f4e2b1..13ef62f 100644
--- a/lib/some.js
+++ b/lib/some.js
@@ -8,7 +8,8 @@ import doLimit from './internal/doLimit';
*
* @name some
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @alias any
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/someLimit.js b/lib/someLimit.js
index 50beb65..b9d5cc5 100644
--- a/lib/someLimit.js
+++ b/lib/someLimit.js
@@ -7,8 +7,9 @@ import identity from 'lodash/identity';
*
* @name someLimit
* @static
- * @memberOf async
- * @see async.some
+ * @memberOf module:async
+ * @method
+ * @see [async.some]{@link module:async.some}
* @alias anyLimit
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/someSeries.js b/lib/someSeries.js
index 18fd5ca..fa3e0e3 100644
--- a/lib/someSeries.js
+++ b/lib/someSeries.js
@@ -6,8 +6,9 @@ import doLimit from './internal/doLimit';
*
* @name someSeries
* @static
- * @memberOf async
- * @see async.some
+ * @memberOf module:async
+ * @method
+ * @see [async.some]{@link module:async.some}
* @alias anySeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
diff --git a/lib/sortBy.js b/lib/sortBy.js
index 539a829..8d8fd0d 100644
--- a/lib/sortBy.js
+++ b/lib/sortBy.js
@@ -9,7 +9,8 @@ import map from './map';
*
* @name sortBy
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {Function} iteratee - A function to apply to each item in `coll`.
diff --git a/lib/timeout.js b/lib/timeout.js
index 1ce5378..f5974ff 100644
--- a/lib/timeout.js
+++ b/lib/timeout.js
@@ -7,7 +7,8 @@ import initialParams from './internal/initialParams';
*
* @name timeout
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Util
* @param {Function} asyncFn - The asynchronous function you want to set the
* time limit.
diff --git a/lib/times.js b/lib/times.js
index 1d5b6c3..62843c6 100644
--- a/lib/times.js
+++ b/lib/times.js
@@ -7,8 +7,9 @@ import doLimit from './internal/doLimit';
*
* @name times
* @static
- * @memberOf async
- * @see async.map
+ * @memberOf module:async
+ * @method
+ * @see [async.map]{@link module:async.map}
* @category Control Flow
* @param {number} n - The number of times to run the function.
* @param {Function} iteratee - The function to call `n` times. Invoked with the
diff --git a/lib/timesLimit.js b/lib/timesLimit.js
index b4db62c..302c803 100644
--- a/lib/timesLimit.js
+++ b/lib/timesLimit.js
@@ -7,8 +7,9 @@ import range from 'lodash/_baseRange';
*
* @name timesLimit
* @static
- * @memberOf async
- * @see async.times
+ * @memberOf module:async
+ * @method
+ * @see [async.times]{@link module:async.times}
* @category Control Flow
* @param {number} count - The number of times to run the function.
* @param {number} limit - The maximum number of async operations at a time.
diff --git a/lib/timesSeries.js b/lib/timesSeries.js
index 28a5434..2a46a73 100644
--- a/lib/timesSeries.js
+++ b/lib/timesSeries.js
@@ -6,8 +6,9 @@ import doLimit from './internal/doLimit';
*
* @name timesSeries
* @static
- * @memberOf async
- * @see async.times
+ * @memberOf module:async
+ * @method
+ * @see [async.times]{@link module:async.times}
* @category Control Flow
* @param {number} n - The number of times to run the function.
* @param {Function} iteratee - The function to call `n` times. Invoked with the
diff --git a/lib/transform.js b/lib/transform.js
index 55fd067..4025fd7 100644
--- a/lib/transform.js
+++ b/lib/transform.js
@@ -9,7 +9,8 @@ import eachOf from './eachOf';
*
* @name transform
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {*} [accumulator] - The initial state of the transform. If omitted,
diff --git a/lib/unmemoize.js b/lib/unmemoize.js
index e7d9765..e8537d9 100644
--- a/lib/unmemoize.js
+++ b/lib/unmemoize.js
@@ -4,8 +4,9 @@
*
* @name unmemoize
* @static
- * @memberOf async
- * @see async.memoize
+ * @memberOf module:async
+ * @method
+ * @see [async.memoize]{@link module:async.memoize}
* @category Util
* @param {Function} fn - the memoized function
* @returns {Function} a function that calls the original unmemoized function
diff --git a/lib/until.js b/lib/until.js
index 910e049..0b5fde8 100644
--- a/lib/until.js
+++ b/lib/until.js
@@ -9,8 +9,9 @@ import whilst from './whilst';
*
* @name until
* @static
- * @memberOf async
- * @see async.whilst
+ * @memberOf module:async
+ * @method
+ * @see [async.whilst]{@link module:async.whilst}
* @category Control Flow
* @param {Function} test - synchronous truth test to perform before each
* execution of `fn`. Invoked with ().
diff --git a/lib/waterfall.js b/lib/waterfall.js
index 9478bd9..cd75b91 100644
--- a/lib/waterfall.js
+++ b/lib/waterfall.js
@@ -13,7 +13,8 @@ import onlyOnce from './internal/onlyOnce';
*
* @name waterfall
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Control Flow
* @param {Array} tasks - An array of functions to run, each function is passed
* a `callback(err, result1, result2, ...)` it must call on completion. The
diff --git a/lib/whilst.js b/lib/whilst.js
index ee1c19a..d6e6591 100644
--- a/lib/whilst.js
+++ b/lib/whilst.js
@@ -7,7 +7,8 @@ import rest from 'lodash/rest';
*
* @name whilst
* @static
- * @memberOf async
+ * @memberOf module:async
+ * @method
* @category Control Flow
* @param {Function} test - synchronous truth test to perform before each
* execution of `fn`. Invoked with ().
diff --git a/package.json b/package.json
index 3972813..c386f5b 100644
--- a/package.json
+++ b/package.json
@@ -36,11 +36,14 @@
"esdoc": "^0.4.7",
"eslint": "^2.11.1",
"fs-extra": "^0.26.7",
+ "ink-docstrap": "^1.2.1",
+ "jsdoc": "^3.4.0",
"karma": "^0.13.2",
"karma-browserify": "^4.2.1",
"karma-firefox-launcher": "^0.1.6",
"karma-mocha": "^0.2.0",
"karma-mocha-reporter": "^1.0.2",
+ "minami": "^1.1.1",
"mocha": "^2.2.5",
"native-promise-only": "^0.8.0-a",
"nyc": "^2.1.0",
@@ -58,6 +61,7 @@
"coverage": "nyc npm test && nyc report",
"coveralls": "nyc npm test && nyc report --reporter=text-lcov | coveralls",
"doc": "esdoc -c ./support/esdoc.json",
+ "jsdocs": "jsdoc -c ./support/jsdoc.json",
"lint": "eslint lib/ mocha_test/ perf/memory.js perf/suites.js perf/benchmark.js support/ karma.conf.js",
"mocha-browser-test": "karma start",
"mocha-node-test": "mocha mocha_test/ --compilers js:babel-core/register",
diff --git a/support/jsdoc.json b/support/jsdoc.json
new file mode 100644
index 0000000..ac95082
--- /dev/null
+++ b/support/jsdoc.json
@@ -0,0 +1,21 @@
+{
+ "tags": {
+ "allowUnknownTags": true,
+ "dictionaries": ["jsdoc"]
+ },
+ "source": {
+ "include": [ "./lib" ]
+ },
+ "plugins": ["plugins/markdown"],
+ "opts": {
+ "readme": "README.md",
+ "template": "node_modules/minami",
+ "encoding": "utf8",
+ "destination": "./docs",
+ "recurse": true
+ },
+ "templates": {
+ "cleverLinks": false,
+ "theme": "cerulean"
+ }
+}