SBoudrias / gulp-validate-jsdoc

Ensure your JsDoc covers every functions parameters.
MIT License
7 stars 3 forks source link

gulp-validate-jsdoc Build Status

Ensure your JsDoc covers every functions parameters.

Install

$ npm install --save-dev gulp-validate-jsdoc

Usage

Just add the validateJsDoc() in the pipe. No options, no nothing.

var gulp = require('gulp');
var validateJsDoc = require('gulp-validate-jsdoc');

gulp.task('default', function () {
    return gulp.src('src/app.js')
        .pipe(validateJsDoc())
        .pipe(gulp.dest('dist'));
});

License

MIT © Simon Boudrias