Package Exports
- jsdoc-api
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jsdoc-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
jsdoc-api
Example
const jsdoc = require('jsdoc-api')- jsdoc-api
- .explainSync([options]) ⇒
object - .explain([options]) ⇒
Promise - .createExplainStream([options]) ⇒
Duplex - .renderSync()
- .explainSync([options]) ⇒
jsdoc.explainSync([options]) ⇒ object
Returns jsdoc explain output
Kind: static method of jsdoc-api
Node: Requires version 0.12 and above
| Param | Type |
|---|---|
| [options] | object |
| [options.files] | string | Array.<string> |
| [options.source] | string |
jsdoc.explain([options]) ⇒ Promise
Kind: static method of jsdoc-api
Throws:
INVALID_FILES- One or more files was not valid source code
Fulfil: object[] - jsdoc explain output
| Param | Type |
|---|---|
| [options] | object |
| [options.files] | string | Array.<string> |
| [options.source] | string |
| [options.configure] |
jsdoc.createExplainStream([options]) ⇒ Duplex
Kind: static method of jsdoc-api
| Param | Type |
|---|---|
| [options] | object |
| [options.files] | string | Array.<string> |
| [options.source] | string |
| [options.configure] |
jsdoc.renderSync()
Kind: static method of jsdoc-api
| Param | Type | Description |
|---|---|---|
| [options.files] | string | Array.<string> |
|
| [options.source] | string |
|
| [options.configure] | ||
| [options.destination] | destination path |
© 2015 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.