timhovius/documentor-bundle

Symfony2 bundle to implement phpDocumentor into any project from which the documentation is accessible with a browser.

README

What is DocumentorBundle?

DocumentorBundle is a Symfony2 bundle that wraps phpDocumentor2 to generate your project's documentation., _(*1)

Basic Usage

1. Install and enable the bundle for your project's development environment
2. Run app/console documentation:create to generate the documentation for files located in ./src
3. Your project documentation is now available at web/bundles/documentor or http://yourproject.dev/app_dev.php/bundles/documentor/index.html

Features

DocumentorBundle boasts the following features:, _(*2)

• 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.

Requirements

DocumentorBundle requires the following:, _(*3)

• PHP 5.3.3 or higher

Installation

The suggested install method is via Composer, _(*4)

1. Add DocumentorBundle to your composer.json file:, _(*5)

   {
       "require-dev": {
           "timhovius/phpdocumentor-bundle": "~1.0"
       }
   }
   

2. Tell Composer to update this bundle:, _(*6)

   php composer.phar update artur-gajewski/phpdocumentor-bundle
   

3. Enable the bundle for your development environment:, _(*7)

   // app/AppKernel.php
   
       public function registerBundles()
       {
           // Register normal bundles
   
           if (in_array($this->getEnvironment(), array('dev', 'test'))) {
               // ...
               $bundles[] = new Documentor\Bundle\DocumentorBundle\DocumentorBundle();
           }
       }
   

How to use DocumentorBundle?

Go to your project root and generate the documentation using the bundle's built-in DocumentorCommand:, _(*8)

$ app/console documentation:create

This command will generate documentation for all files in the src/ directory., _(*9)

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, _(*10)