PHPackages                             timhovius/documentor-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. timhovius/documentor-bundle

ActiveSymfony-bundle

timhovius/documentor-bundle
===========================

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

v1.0(10y ago)019MITPHPPHP >=5.3.3

Since Nov 26Pushed 10y ago1 watchersCompare

[ Source](https://github.com/timhovius/DocumentorBundle)[ Packagist](https://packagist.org/packages/timhovius/documentor-bundle)[ Docs](https://github.com/timhovius/DocumentorBundle)[ RSS](/packages/timhovius-documentor-bundle/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

README
======

[](#readme)

What is DocumentorBundle?
-------------------------

[](#what-is-documentorbundle)

DocumentorBundle is a Symfony2 bundle that wraps [phpDocumentor2](https://github.com/phpDocumentor/phpDocumentor2) to generate your project's documentation.

Basic Usage
-----------

[](#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](http://yourproject.dev/app_dev.php/bundles/documentor/index.html)

Features
--------

[](#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
------------

[](#requirements)

DocumentorBundle requires the following:

- PHP 5.3.3 or higher

Installation
------------

[](#installation)

The suggested install method is via [Composer](http://getcomposer.org)

1. Add DocumentorBundle to your `composer.json` file:

    ```
    {
        "require-dev": {
            "timhovius/phpdocumentor-bundle": "~1.0"
        }
    }
    ```
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 Documentor\Bundle\DocumentorBundle\DocumentorBundle();
            }
        }
    ```

How to use 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](http://yourproject.dev/app_dev.php/bundles/documentor/index.html)

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 50% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3822d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/bcf9d7869c19ea708c1da4f1fb74d1513fb9b0fe84ebd8aeb4f8002fca9d3755?d=identicon)[timhovius](/maintainers/timhovius)

---

Top Contributors

[![johnkary](https://avatars.githubusercontent.com/u/135607?v=4)](https://github.com/johnkary "johnkary (4 commits)")[![lineke](https://avatars.githubusercontent.com/u/1242047?v=4)](https://github.com/lineke "lineke (2 commits)")[![philwc](https://avatars.githubusercontent.com/u/617110?v=4)](https://github.com/philwc "philwc (1 commits)")[![timhovius](https://avatars.githubusercontent.com/u/7972792?v=4)](https://github.com/timhovius "timhovius (1 commits)")

---

Tags

phpDocumentor

### Embed Badge

![Health badge](/badges/timhovius-documentor-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/timhovius-documentor-bundle/health.svg)](https://phpackages.com/packages/timhovius-documentor-bundle)
```

###  Alternatives

[phpdocumentor/reflection-common

Common reflection classes used by phpdocumentor to reflect the code structure

9.1k706.8M26](/packages/phpdocumentor-reflection-common)[phpdocumentor/reflection

Reflection library to do Static Analysis for PHP Projects

12521.4M109](/packages/phpdocumentor-reflection)[cvuorinen/phpdoc-markdown-public

phpDocumentor template that generates Markdown documentation of the public API

3613.8k16](/packages/cvuorinen-phpdoc-markdown-public)[saggre/phpdocumentor-markdown

Markdown template for phpDocumentor3

2079.5k30](/packages/saggre-phpdocumentor-markdown)[nelson6e65/phpdoc-vuepress

Template for generating your PHP API documentation in a pretty VuePress format.

224.5k2](/packages/nelson6e65-phpdoc-vuepress)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)