endroid/documenter

Endroid Documenter

1.0.0 2020-05-28 11:10 UTC

Requires

• php: >=7.2

Requires (Dev)

• endroid/quality: dev-master

Suggests

• roave/security-advisories: Avoids installation of package versions with vulnerabilities
• symfony/security-checker: Checks your composer.lock for vulnerabilities

MIT

• Jeroen van den Enden

• endroid
• yuml
• documenter

README

By endroid

Library that helps building technical documentation by automatic generation from your source code. Use the provided annotations to include resources in the generated class diagrams, object descriptions etc.

Installation

Use Composer to install the library.

composer require endroid/documenter

When you use Symfony, the installer makes sure that services are automatically wired. If this is not the case you can find the configuration files in the .install/symfony folder.

Usage

...

Versioning

Version numbers follow the MAJOR.MINOR.PATCH scheme. Backwards compatible changes will be kept to a minimum but be aware that these can occur. Lock your dependencies for production and test your code when upgrading.

License

This bundle is under the MIT license. For the full copyright and license information please view the LICENSE file that was distributed with this source code.