- jsdoc-api
- jsdoc ⏏
- static
- .explain([options]) ⇒
Promise
- .render([options])
- .explain([options]) ⇒
- inner
- ~JsdocOptions
- .files :
string
|Array.<string>
- .source :
string
|Array.<string>
- .cache :
boolean
- .access :
string
- .configure :
string
- .destination :
string
- .encoding :
string
- .private :
boolean
- .package :
string
- .pedantic :
boolean
- .query :
string
- .recurse :
boolean
- .readme :
string
- .template :
string
- .tutorials :
string
- .files :
- ~cache :
cache-point
- ~JsdocOptions
- static
- jsdoc ⏏
Returns a promise for the jsdoc explain output.
Kind: static method of jsdoc
Fulfil: object[]
- jsdoc explain output
Param | Type |
---|---|
[options] | JsdocOptions |
Render jsdoc documentation.
Kind: static method of jsdoc
Prerequisite: Requires node v0.12 or above
Param | Type |
---|---|
[options] | JsdocOptions |
Example
await jsdoc.render({ files: 'lib/*', destination: 'api-docs' })
The jsdoc options, common for all operations.
Kind: inner class of jsdoc
- ~JsdocOptions
- .files :
string
|Array.<string>
- .source :
string
|Array.<string>
- .cache :
boolean
- .access :
string
- .configure :
string
- .destination :
string
- .encoding :
string
- .private :
boolean
- .package :
string
- .pedantic :
boolean
- .query :
string
- .recurse :
boolean
- .readme :
string
- .template :
string
- .tutorials :
string
- .files :
One or more filenames to process. Either files
, source
or configure
must be supplied.
Kind: instance property of JsdocOptions
A string or an array of strings containing source code to process. Either files
, source
or configure
must be supplied.
Kind: instance property of JsdocOptions
Set to true
to cache the output - future invocations with the same input will return immediately.
Kind: instance property of JsdocOptions
Only display symbols with the given access: "public", "protected", "private" or "undefined", or "all" for all access levels. Default: all except "private".
Kind: instance property of JsdocOptions
The path to the configuration file. Default: path/to/jsdoc/conf.json. Either files
, source
or configure
must be supplied.
Kind: instance property of JsdocOptions
The path to the output folder. Use "console" to dump data to the console. Default: ./out/.
Kind: instance property of JsdocOptions
Assume this encoding when reading all source files. Default: utf8.
Kind: instance property of JsdocOptions
Display symbols marked with the @private tag. Equivalent to "--access all". Default: false.
Kind: instance property of JsdocOptions
The path to the project's package file. Default: path/to/sourcefiles/package.json
Kind: instance property of JsdocOptions
Treat errors as fatal errors, and treat warnings as errors. Default: false.
Kind: instance property of JsdocOptions
A query string to parse and store in jsdoc.env.opts.query. Example: foo=bar&baz=true.
Kind: instance property of JsdocOptions
Recurse into subdirectories when scanning for source files and tutorials.
Kind: instance property of JsdocOptions
The path to the project's README file. Default: path/to/sourcefiles/README.md.
Kind: instance property of JsdocOptions
The path to the template to use. Default: path/to/jsdoc/templates/default.
Kind: instance property of JsdocOptions
Directory in which JSDoc should search for tutorials.
Kind: instance property of JsdocOptions
jsdoc~cache : cache-point
The cache-point instance used when cache: true
is specified on .explain()
.
Kind: inner constant of jsdoc