summaryrefslogtreecommitdiff
path: root/lib/doWhilst.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/doWhilst.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/doWhilst.js')
-rw-r--r--lib/doWhilst.js9
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/doWhilst.js b/lib/doWhilst.js
index 655ede9..344339d 100644
--- a/lib/doWhilst.js
+++ b/lib/doWhilst.js
@@ -1,16 +1,19 @@
import whilst from './whilst';
/**
- * The post-check version of {@link async.whilst}. To reflect the difference in
+ * ```
+ * import doWhilst from 'async/doWhilst'
+ * ```
+ * The post-check version of [`whilst`]{@link module:ControlFlow.whilst}. To reflect the difference in
* the order of operations, the arguments `test` and `fn` are switched.
*
* `doWhilst` is to `whilst` as `do while` is to `while` in plain JavaScript.
*
* @name doWhilst
* @static
- * @memberOf module:async
+ * @memberOf module:ControlFlow
* @method
- * @see [async.whilst]{@link module:async.whilst}
+ * @see [async.whilst]{@link module:ControlFlow.whilst}
* @category Control Flow
* @param {Function} fn - A function which is called each time `test` passes.
* The function is passed a `callback(err)`, which must be called once it has