Skip to content

Latest commit

 

History

History
180 lines (132 loc) · 9.36 KB

api.md

File metadata and controls

180 lines (132 loc) · 9.36 KB

jsdoc-api

jsdoc ⏏

Kind: Exported constant

jsdoc.explain([options]) ⇒ Promise

Returns a promise for the jsdoc explain output.

Kind: static method of jsdoc
Fulfil: object[] - jsdoc explain output

Param Type
[options] JsdocOptions

jsdoc.render([options])

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' })

jsdoc~JsdocOptions

The jsdoc options, common for all operations.

Kind: inner class of jsdoc

options.files : string | Array.<string>

One or more filenames to process. Either files, source or configure must be supplied.

Kind: instance property of JsdocOptions

options.source : string | Array.<string>

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

options.cache : boolean

Set to true to cache the output - future invocations with the same input will return immediately.

Kind: instance property of JsdocOptions

options.access : string

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

options.configure : string

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

options.destination : string

The path to the output folder. Use "console" to dump data to the console. Default: ./out/.

Kind: instance property of JsdocOptions

options.encoding : string

Assume this encoding when reading all source files. Default: utf8.

Kind: instance property of JsdocOptions

options.private : boolean

Display symbols marked with the @private tag. Equivalent to "--access all". Default: false.

Kind: instance property of JsdocOptions

options.package : string

The path to the project's package file. Default: path/to/sourcefiles/package.json

Kind: instance property of JsdocOptions

options.pedantic : boolean

Treat errors as fatal errors, and treat warnings as errors. Default: false.

Kind: instance property of JsdocOptions

options.query : string

A query string to parse and store in jsdoc.env.opts.query. Example: foo=bar&baz=true.

Kind: instance property of JsdocOptions

options.recurse : boolean

Recurse into subdirectories when scanning for source files and tutorials.

Kind: instance property of JsdocOptions

options.readme : string

The path to the project's README file. Default: path/to/sourcefiles/README.md.

Kind: instance property of JsdocOptions

options.template : string

The path to the template to use. Default: path/to/jsdoc/templates/default.

Kind: instance property of JsdocOptions

options.tutorials : string

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