Package Exports

gulp-jsdoc3

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-jsdoc3) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gulp-jsdoc3

jsdoc plugin for gulp

Install gulp-jsdoc as a development dependency:

npm install --save-dev gulp-jsdoc3

Then, use it where config is the only way to pass in jsdoc options. All CLI options are can be specified here, the only exception is ink-docstrap is bundled here and used for templating.

var jsdoc = require('gulp-jsdoc3');

gulp.task('doc', function (cb) {
    gulp.src(['README.md', './src/**/*.js'], {read: false})
        .pipe(jsdoc(config, cb));
});

Another good example is in this project's gulpfile!

Debugging

Set env variable: DEBUG=gulp-jsdoc3

Notes

This is a reasonable attempt to wrap jsdoc using gulp as thinly as possible. All files are added after the cli. i.e. jsdoc -c config -t node_modules/ink-docstrap/template gulpFile1 gulpFile2
jsdoc does not allow for piped input, so this attempt may be considered a gulp anti-pattern. It also does not pass on output to be piped elsewhere.

I would like to thank Mangled Deutz @ gulp-jsdoc for the original implimentation.

License

Apache-2.0 License