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/everySeries.js b/lib/everySeries.js
index 0b3db2c..aca6cec 100644
--- a/lib/everySeries.js
+++ b/lib/everySeries.js
@@ -3,4 +3,22 @@
 import everyLimit from './everyLimit';
 import doLimit from './internal/doLimit';
 
+/**
+ * The same as `every` but runs only a single async operation at a time.
+ *
+ * @name everySeries
+ * @static
+ * @memberOf async
+ * @see async.every
+ * @alias allSeries
+ * @category Collection
+ * @param {Array|Object} coll - A collection to iterate over.
+ * @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 doLimit(everyLimit, 1);