Easy PHP files documentation (PHPDoc) update. Experimental project in progress.
PHP
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Sly/PHPDocUpdator
bin
config
.gitignore
.travis.yml
README.md
composer.json
phpunit.xml.dist

README.md

PHPDocUpdator

Continuous Integration status

What is it?

PHPDocUpdator was created to make easy PHPDoc comments updates from CLI.

Dependencies

PHPDocUpdator uses some dependency packages managed with Composer:

Installation

git clone git@github.com:Ph3nol/PHPDocUpdator.git PHPDocUpdator
cd PHPDocUpdator
curl -s http://getcomposer.org/installer | php
php composer.phar install
cp config/config.yml.default config/config.yml

Usage

Edit config/config.yml file, following this example:

debug: false
phpdoc:
    author: "Cédric Dugat <ph3@slynett.com>"
    version: "1.0"
include:
    - "path/to/the/folder/1"
    - "path/to/the/folder/2"
    - "path/to/the/folder/3":
        phpdoc: { package: "Test", version: "1.01" }
exclude:
    - "path/to/the/folder/to/exclude"

Declare all needed parameters (available soon) and use update command to apply PHPDoc comments improvements:

./bin/phpdu update --config=/path/to/config.yml

Or not set config option for a config file suggestion:

./bin/phpdu update

To be continued.