Sunday, 12 March 2017

Exclude Externals from jsDoc output

How can we exclude Externals section from jsDoc output correctly?

I have lots of externals in my project that I do not want to show on the navigation panel at all, as it takes up all the space, and is useless to us.

I have been able to hack it manually, by changing the code in file node_modules\jsdoc\lib\util\templateHelper.js, but this is not a reusable approach for my team of developers.

The hack was in overriding members.externals with an empty array:

/*
    members.externals = members.externals.map(function(doclet) {
        doclet.name = doclet.name.replace(/(^"|"$)/g, '');
        return doclet;
    });
*/
    members.externals = [];



via vitaly-t

No comments:

Post a Comment