Methods
(async) publicize(conf, deployopt, timeoutopt) → {Boolean}
Generates the JSDoc style results using any number of template providers. See README
for more details.
See Getting Started documentation for default values that are ported over from jsdoc-defaults.conf
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
conf |
String
|
Conf
|
Either the path to the JSDoc configuration file or the actual JSDoc configuration itself. |
||
deploy |
Boolean
|
<optional> |
false |
|
timeout |
Integer
|
<optional> |
30000 |
The number of milliseconds before timing out for each underlying execution |
Returns:
- Type:
-
Boolean
true when completed successfully