Global

Methods

---

jsdoc( [config], done)

A wrapper around jsdoc cli.

This function collects all filenames. Then runs: jsdoc -c config -t node_modules/ink-docstrap/template gulpFile1 gulpFile2

Parameters:

Name	Type	Argument	Default	Description
config	Object	<optional>	require('./jsdocConfig.json')
done	gulpDoneCallback

Returns:

Type

* | SignalBinding

Example

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

Type Definitions

---

gulpDoneCallback()