jsdoc-style documentation for 'collection' methods

Converted documentation from README to jsdoc-style for respective
methods. Currently, only done for 'collection' methods.

jsdoc-style documentation - fixed 'collection' methods documentation

Only the base functions now contain an example, while the `series` and
`limit` versions simply contain a reference to the base function. Fixed
styling issue and misspelled tag.

1 files changed, 19 insertions, 0 deletions

diff --git a/lib/eachSeries.js b/lib/eachSeries.js
index 39dc81f..470c34c 100644
--- a/lib/eachSeries.js
+++ b/lib/eachSeries.js
@@ -3,4 +3,23 @@
 import eachLimit from './eachLimit';
 import doLimit from './internal/doLimit';
 
+/**
+ * The same as `each` but runs only a single async operation at a time.
+ *
+ * @name eachSeries
+ * @static
+ * @memberOf async
+ * @see async.each
+ * @alias forEachSeries
+ * @category Collection
+ * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Function} iteratee - A function to apply to each
+ * item in `coll`. The iteratee is passed a `callback(err)` which must be called
+ * once it has completed. If no error has occurred, the `callback` should be run
+ * without arguments or with an explicit `null` argument. The array index is
+ * not passed to the iteratee. Invoked with (item, callback). If you need the
+ * index, use `eachOfSeries`.
+ * @param {Function} [callback] - A callback which is called when all
+ * `iteratee` functions have finished, or an error occurs. Invoked with (err).
+ */
 export default doLimit(eachLimit, 1);