npm install gulp-cod``js
var gulp = require('gulp'),
cod = require('gulp-cod');
gulp.task('cod', function () {
gulp.src('src/*.js')
.pipe(cod())
.pipe(gulp.dest('./docs'));
});
`
`js
var gulp = require('gulp'),
cod = require('gulp-cod');
gulp.task('cod', function () {
gulp.src('src/*.coffee')
.pipe(cod({
docBegin: '###*',
docEnd: '###',
pretty: false
}))
.pipe(gulp.dest('./docs'));
});
`
A .json file will be created for each input source file.
If you want to combine multiple input files into a single API doc file, use gulp-concat:
`js
var gulp = require('gulp'),
concat = require('gulp-concat'),
cod = require('gulp-cod');
gulp.task('cod', function () {
gulp.src('src/*.js')
.pipe(concat('all.js'))
.pipe(cod())
.pipe(gulp.dest('./docs'));
});
`
`
npm install gulp-cod --save
MIT
---
