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

diff --git a/lib/rejectLimit.js b/lib/rejectLimit.js
index 7cefed6..9b3fbd3 100644
--- a/lib/rejectLimit.js
+++ b/lib/rejectLimit.js
@@ -3,4 +3,21 @@
 import reject from './internal/reject';
 import doParallelLimit from './internal/doParallelLimit';
 
+/**
+ * The same as `reject` but runs a maximum of `limit` async operations at a
+ * time.
+ *
+ * @name rejectLimit
+ * @static
+ * @memberOf async
+ * @see 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.
+ * @param {Function} iteratee - A truth test to apply to each item in `coll`.
+ * The `iteratee` is passed a `callback(err, truthValue)`, which must be called
+ * with a boolean argument once it has completed. Invoked with (item, callback).
+ * @param {Function} [callback] - A callback which is called after all the
+ * `iteratee` functions have finished. Invoked with (err, results).
+ */
 export default doParallelLimit(reject);