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/everyLimit.js b/lib/everyLimit.js
index 4b3fc5f..1c3511c 100644
--- a/lib/everyLimit.js
+++ b/lib/everyLimit.js
@@ -4,4 +4,23 @@ import createTester from './internal/createTester';
 import eachOfLimit from './eachOfLimit';
 import notId from './internal/notId';
 
+/**
+ * The same as `every` but runs a maximum of `limit` async operations at a time.
+ *
+ * @name everyLimit
+ * @static
+ * @memberOf async
+ * @see every
+ * @alias allLimit
+ * @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 the
+ * collection in parallel. 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. Result will be either `true` or `false`
+ * depending on the values of the async tests. Invoked with (err, result).
+ */
 export default createTester(eachOfLimit, notId, notId);