jsdoc-style documentation finished documenting `Util` methods

need to rebase to master before I can document the recently added
reflect functions

jsdoc-style documentation finished for 'Util' methods

documented the new `reflect` and `reflectAll` functions

1 files changed, 39 insertions, 0 deletions

diff --git a/lib/reflectAll.js b/lib/reflectAll.js
index c4ecd9f..2a0f197 100644
--- a/lib/reflectAll.js
+++ b/lib/reflectAll.js
@@ -2,6 +2,45 @@
 
 import reflect from './reflect';
 
+/**
+ * A helper function that wraps an array of functions with reflect.
+ *
+ * @name reflectAll
+ * @static
+ * @memberOf async
+ * @see `async.reflect`
+ * @category Util
+ * @param {Array} tasks - The array of functions to wrap in `async.reflect`.
+ * @returns {Array} Returns an array of functions, each function wrapped in
+ * `async.reflect`
+ * @example
+ *
+ * let tasks = [
+ *     function(callback) {
+ *         setTimeout(function() {
+ *             callback(null, 'one');
+ *         }, 200);
+ *     },
+ *     function(callback) {
+ *         // do some more stuff but error ...
+ *         callback(new Error('bad stuff happened'));
+ *     },
+ *     function(callback) {
+ *         setTimeout(function() {
+ *             callback(null, 'two');
+ *         }, 100);
+ *     }
+ * ];
+ *
+ * async.parallel(async.reflectAll(tasks),
+ * // optional callback
+ * function(err, results) {
+ *     // values
+ *     // results[0].value = 'one'
+ *     // results[1].error = Error('bad stuff happened')
+ *     // results[2].value = 'two'
+ * });
+ */
 export default function reflectAll(tasks) {
     return tasks.map(reflect);
 }