DocumentorBundle is a Symfony2 bundle that wraps phpDocumentor2 to generate your project's documentation.
- Install and enable the bundle for your project's development environment
- Run
app/console documentation:create
to generate the documentation for files located in./src
- Your project documentation is now available at
web/bundles/documentor
or http://yourproject.dev/app_dev.php/bundles/documentor/index.html
DocumentorBundle boasts the following features:
- Generates documentation with a simple console command.
- No need to enter source and target paths.
- Configurable to make sure it only works in your development environment.
DocumentorBundle requires the following:
- PHP 5.3.3 or higher
The suggested install method is via Composer
-
Add DocumentorBundle to your
composer.json
file:{ "require-dev": { "timhovius/phpdocumentor-bundle": "~1.0" } }
-
Tell Composer to update this bundle:
php composer.phar update artur-gajewski/phpdocumentor-bundle
-
Enable the bundle for your development environment:
// app/AppKernel.php public function registerBundles() { // Register normal bundles if (in_array($this->getEnvironment(), array('dev', 'test'))) { // ... $bundles[] = new Documentor\Bundle\DocumentorBundle\DocumentorBundle(); } }
Go to your project root and generate the documentation using the bundle's built-in DocumentorCommand:
$ app/console documentation:create
This command will generate documentation for all files in the src/
directory.
After generating the documentation, the command executes app/console assets:install
to copy the newly generated documentation to web/bundles/documentor
, where you can access it from disk or via your project's website at http://yourproject.dev/app_dev.php/bundles/documentor/index.html