gulp-apidoc

How It Works

/** *@api {get} /user/:id Request User information *@apiName GetUser *@apiGroup User * *@apiParam {Number} id Users unique ID. * *@apiSuccess {String} firstname Firstname of the User. *@apiSuccess {String} lastname  Lastname of the User. */

Install

npm install --save-dev gapidoc

Usage

vargulp=require('gulp'),apidoc=require('gapidoc');gulp.task('apidoc',function(){apidoc.exec({src:"example/",dest:"build/"});});

vargulp=require('gulp'),apidoc=require('gapidoc');gulp.task('apidoc',function(){apidoc.exec({src:"example/",dest:"build/",debug:true,includeFilters:[".*\\.js$"]});});

API

apidoc(options)

options.src

options.dest

options.debug

options.log

options.includeFilters