Download the PHP package timhovius/documentor-bundle without Composer
On this page you can find all versions of the php package timhovius/documentor-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download timhovius/documentor-bundle
More information about timhovius/documentor-bundle
Files in timhovius/documentor-bundle
Package documentor-bundle
Short Description Symfony2 bundle to implement phpDocumentor into any project from which the documentation is accessible with a browser.
License MIT
Homepage https://github.com/timhovius/DocumentorBundle
Informations about the package documentor-bundle
README
What is DocumentorBundle?
DocumentorBundle is a Symfony2 bundle that wraps phpDocumentor2 to generate your project's documentation.
Basic Usage
- 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
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
Installation
The suggested install method is via Composer
-
Add DocumentorBundle to your
composer.json
file: -
Tell Composer to update this bundle:
- Enable the bundle for your development environment:
How to use DocumentorBundle?
Go to your project root and generate the documentation using the bundle's built-in DocumentorCommand:
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