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(files) ⇒
object- .source(source) ⇒
Array.<object>
- .source(source) ⇒
- .explain(files) ⇒
Promise- .source(source) ⇒
Promise
- .source(source) ⇒
- .renderSync(files, [options])
- .explainSync(files) ⇒
jsdoc.explainSync(files) ⇒ object
Kind: static method of jsdoc-api
Returns: object - - jsdoc explain output
| Param | Type | Description |
|---|---|---|
| files | string | Array.<string> |
input file names |
explainSync.source(source) ⇒ Array.<object>
Kind: static method of explainSync
Returns: Array.<object> - - jsdoc explain output
| Param | Type | Description |
|---|---|---|
| source | string |
source code |
jsdoc.explain(files) ⇒ Promise
Kind: static method of jsdoc-api
Fulfil: object[] - jsdoc explain output
| Param | Type | Description |
|---|---|---|
| files | string | Array.<string> |
input source files |
explain.source(source) ⇒ Promise
Kind: static method of explain
Fulfil: object[] - jsdoc explain output
| Param | Type | Description |
|---|---|---|
| source | string |
input source code |
jsdoc.renderSync(files, [options])
Kind: static method of jsdoc-api
| Param | Type | Description |
|---|---|---|
| files | string | Array.<string> |
input source files |
| [options] | object |
options |
| [options.destination] | destination path |
renderSync.source(source, [options])
Kind: static method of renderSync
| Param | Type | Description |
|---|---|---|
| source | string |
the source code |
| [options] | object |
options |
| [options.destination] | destination path |
© 2015 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.