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:

var jsdocx = require('jsdoc-x');

Parse using Promises...

jsdocx.parse('./src/**/*.js')
    .then(function (docs) {
        console.log(docs);
    })
    .catch(function (err) {
        console.log(err.stack);
    });

Or callback...

var options = { files: './src/**/*.js', hierarchy: true };
jsdocx.parse(options, function (err, docs) {
    if (err) {
        console.log(err.stack);
        return;
    }
    console.log(docs);
});

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.