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, 18 insertions, 0 deletions

diff --git a/lib/concatSeries.js b/lib/concatSeries.js
index 76f4043..73312dc 100644
--- a/lib/concatSeries.js
+++ b/lib/concatSeries.js
@@ -3,4 +3,22 @@
 import concat from './internal/concat';
 import doSeries from './internal/doSeries';
 
+/**
+ * The same as `concat` but runs only a single async operation at a time.
+ *
+ * @name concatSeries
+ * @static
+ * @memberOf async
+ * @see async.concat
+ * @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, results)` which must be called once
+ * it has completed with an error (which can be `null`) and an array of results.
+ * Invoked with (item, callback).
+ * @param {Function} [callback(err)] - A callback which is called after all the
+ * `iteratee` functions have finished, or an error occurs. Results is an array
+ * containing the concatenated results of the `iteratee` function. Invoked with
+ * (err, results).
+ */
 export default doSeries(concat);