2017 © Pedro Peláez
 

symfony-bundle documentor-bundle

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

image

artur-gajewski/documentor-bundle

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

  • Tuesday, September 17, 2013
  • by artur-gajewski
  • Repository
  • 0 Watchers
  • 7 Stars
  • 10,181 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 6 Forks
  • 2 Open issues
  • 1 Versions
  • 2 % Grown

The README.md

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/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:, (*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
  • phpDocumentor2
  • phpDocumentor2 should be callable as phpdoc from the CLI

Installation

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

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

    {
    "require-dev": {
        "artur-gajewski/phpdocumentor-bundle": "dev-master"
    }
}

  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 Aga\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)

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!, (*11)

The Versions

17/09 2013

dev-master

9999999-dev https://github.com/artur-gajewski/DocumentorBundle

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

  Sources   Download

MIT

The Requires

  • php >=5.3.3

 

by Artur Gajewski

phpdocumentor