Developed with love by KnpLabs Hire us for your project!
0

DocumentorBundle

by artur-gajewski

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.

Basic Usage

  1. Install and enable the bundle for your project's development environment
  2. Run app/consoledocumentation: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:

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

  • PHP 5.3.3 or higher
  • phpDocumentor2
  • phpDocumentor2 should be callable as phpdoc from the CLI

Installation

The suggested install method is via Composer

  1. Add DocumentorBundle to your composer.json file:

    {
        "require-dev": {
            "artur-gajewski/phpdocumentor-bundle": "dev-master"
        }
    }
    
  2. Tell Composer to update this bundle:

    php composer.phar update artur-gajewski/phpdocumentor-bundle
    
  3. 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 Aga\DocumentorBundle\DocumentorBundle();
            }
        }
    

How to use 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

Contact

Want to contribute?

If you want to contribute to this project then just fork it, modify it and send a pull request. It's dead simple!

artur-gajewski/DocumentorBundle

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.