This package has been deprecated

Author message:

This package is no longer mainteined

grunt-phpdocs

0.1.0 • Public • Published

grunt-phpdocs

Built with Grunt

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.loadNpmTasks('grunt-phpdocs');

The "phpdocs" task

Overview

In your project's Gruntfile, add a section named phpdocs to the data object passed into grunt.initConfig().

grunt.initConfig({
  phpdocs: {
    options: {
      phar: ''
    },
    dist: {
      source: './src',
      destination: './docs',
      template: 'clean'
    }
  }
});

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.

  1. Fork it ( https://github.com/b4dnewz/grunt-phpdocs/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Write some tests and run (npm run test)
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request

License

MIT License

Readme

Keywords

Package Sidebar

Install

npm i grunt-phpdocs

Weekly Downloads

2

Version

0.1.0

License

none

Last publish

Collaborators

  • b4dnewz