gulp-phpdox
PHPDox plugin for gulp 3
Usage
First, install gulp-phpdox
as a development dependency:
npm install --save-dev gulp-phpdox
Then, add it to your gulpfile.js
:
var phpdox = ; // option 1: default formatgulp; // option 2: with defined bingulp; // option 3: supply callback to integrate something like notification (using gulp-notify) var gulp = notify = phpdox = ; _ = ; gulp; { var options = title: status == 'done' ? 'Docs Generated!' : 'Failed to Generate Docs!' message: status == 'done' ? '\n\nAPI Documentation has been generated!\n\n' : '\n\nDocumentation has failed to generate...\n\n' icon: __dirname + '/node_modules/gulp-' + pluginName +'/assets/test-' + status + '.png' ; options = _; return options;}
API
(phpdoxpath,configfile,options)
phpdoxpath
Type: String
The path to the desired PHPDox binary
- If not supplied, the default path will be phpdox
options.debug
Type: Boolean (Default: false)
Emit error details and shows command used in console
options.clear
Type: Boolean (Default: false)
Clear console before executing command
options.notify
Type: Boolean (Default: false)
Call user supplied callback to handle notification (use gulp-notify)
Changelog
- 0.1.0: Initial Release
Credits
gulp-phpdox written by Nathan Macnamara
E-Mail: nathan.macnamara@outlook.com
Twitter: @nathmacn