summaryrefslogtreecommitdiff
path: root/lib/dir.js
diff options
context:
space:
mode:
authorHubert Argasinski <argasinski.hubert@gmail.com>2016-06-29 01:35:29 -0400
committerHubert Argasinski <argasinski.hubert@gmail.com>2016-06-29 01:56:11 -0400
commit7eaa3b3a9bee0df38ebc0b640a97de42ca05d5da (patch)
tree942b9ea5e9a18f7f55fd01c51555d0c01f82fc5e /lib/dir.js
parent90c4f893a30044b67d48a62e42d2c42f379a822f (diff)
downloadasync-7eaa3b3a9bee0df38ebc0b640a97de42ca05d5da.tar.gz
jsdocs: using proxy modules as categories, modifying minami theme
jsdocs: style fix in outputted html jsdoc: added documentation to support script
Diffstat (limited to 'lib/dir.js')
-rw-r--r--lib/dir.js7
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/dir.js b/lib/dir.js
index 035e4d2..52ca709 100644
--- a/lib/dir.js
+++ b/lib/dir.js
@@ -1,15 +1,18 @@
import consoleFunc from './internal/consoleFunc';
/**
+ * ```
+ * import dir from 'async/dir'
+ * ```
* Logs the result of an `async` function to the `console` using `console.dir`
* to display the properties of the resulting object. Only works in Node.js or
* in browsers that support `console.dir` and `console.error` (such as FF and
* Chrome). If multiple arguments are returned from the async function,
* `console.dir` is called on each argument in order.
*
- * @name log
+ * @name dir
* @static
- * @memberOf module:async
+ * @memberOf module:Utils
* @method
* @category Util
* @param {Function} function - The function you want to eventually apply all