neo-jsdoc-x v1.0.6

jsdoc-x

© 2020, Onur Yıldırım (@onury). MIT License.

Parser for outputting a Javascript object from documented code via JSDoc's explain (-X) command.

Install via NPM:

npm i jsdoc-x

Usage:

const jsdocx = require('jsdoc-x');
try {
    const docs = await jsdocx.parse('./src/**/*.js');
    console.log(docs);
} catch (err) {
    console.log(err.stack);
}

(If you like pain, .parse() method also supports a callback, instead of promises.)

See an output example here.

jsdocx.parse(options[, callback])

Executes the jsdoc -X command and parses the output into a Javascript object/array; with the specified options.

options

Object|Array|String - Parse options.

jsdocx.filter(docs[, options][, predicate])

Filters the given documentation output array. This is useful if you have an already parsed documentation output.

options

Object - Filter options.

jsdocx.utils

Utilities for documentation output and symbols.

Change-log:

See CHANGELOG.md.