gulp-apidocjs
Generates a RESTful web API Documentation. Documentation at apidocjs.com
Uses the apidoc library.
How It Works
/path/api/stuff.js
:
/** * @api * @apiName GetUser * @apiGroup User * * @apiParam * * @apiSuccess * @apiSuccess */
Install
Install with npm
npm install --save-dev gulp-apidoc
Usage
var gulp = apidoc = ; gulp;
With options:
var gulp = apidoc = ; gulp;
Other options checkout.
API
apidoc(options)
options.src
Type: String
options.dest
Type: string
Default: doc/
options.debug
Type: Boolean
Default: false
options.silent
Type: Boolean
Default: false
options.log
Type: Boolean
Default: true
options.includeFilters
Type: Array
Default: []