diff options
author | Hubert Argasinski <argasinski.hubert@gmail.com> | 2016-06-29 01:35:29 -0400 |
---|---|---|
committer | Hubert Argasinski <argasinski.hubert@gmail.com> | 2016-06-29 01:56:11 -0400 |
commit | 7eaa3b3a9bee0df38ebc0b640a97de42ca05d5da (patch) | |
tree | 942b9ea5e9a18f7f55fd01c51555d0c01f82fc5e /lib/retryable.js | |
parent | 90c4f893a30044b67d48a62e42d2c42f379a822f (diff) | |
download | async-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/retryable.js')
-rw-r--r-- | lib/retryable.js | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/retryable.js b/lib/retryable.js index 45ef5ac..ad47351 100644 --- a/lib/retryable.js +++ b/lib/retryable.js @@ -2,14 +2,17 @@ import retry from './retry'; import initialParams from './internal/initialParams'; /** - * A close relative of `retry`. This method wraps a task and makes it + * ``` + * import retryable from 'async/retryable' + * ``` + * A close relative of [`retry`]{@link module:ControlFlow.retry}. This method wraps a task and makes it * retryable, rather than immediately calling it with retries. * * @name retryable * @static - * @memberOf module:async + * @memberOf module:ControlFlow * @method - * @see [async.retry]{@link module:async.retry} + * @see [async.retry]{@link module:ControlFlow.retry} * @category Control Flow * @param {Object|number} [opts = {times: 5, interval: 0}| 5] - optional * options, exactly the same as from `retry` |