grunt-phpdocs
Create documentation for PHP files with phpDocumentor2
Getting Started
This plugin requires Grunt ~0.4.5
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-phpdocs --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "phpdocs" task
Overview
In your project's Gruntfile, add a section named phpdocs
to the data object passed into grunt.initConfig()
.
grunt;
Global Options
options.phar
Type: String
Default value: null
An an absolute path to an existing PHPDocumentor PHAR file.
Target Options
options.source
Type: String
Default value: '.'
The source folder path from where create the documentation.
options.destination
Type: String
Default value: './docs'
The output path for the documentation.
options.template
Type: String
Default value: 'clean'
The template to use for the documentation.
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
- Fork it ( https://github.com/b4dnewz/grunt-phpdocs/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Write some tests and run (
npm run test
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
License
MIT License