https://github.com/endroid/documenter

Generates documentation from source files
https://github.com/endroid/documenter

Last synced: about 2 months ago
JSON representation

Generates documentation from source files

• Host: GitHub
• URL: https://github.com/endroid/documenter
• Owner: endroid
• License: mit
• Created: 2018-11-14T14:38:04.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-11-07T14:16:54.000Z (over 2 years ago)
• Last Synced: 2025-01-25T11:41:24.685Z (over 1 year ago)
• Language: PHP
• Homepage: https://endroid.nl
• Size: 29.3 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Documenter

*By [endroid](https://endroid.nl/)*

[![Latest Stable Version](http://img.shields.io/packagist/v/endroid/documenter.svg)](https://packagist.org/packages/endroid/documenter)

[![Build Status](https://github.com/endroid/documenter/workflows/CI/badge.svg)](https://github.com/endroid/composer/actions)

[![Total Downloads](http://img.shields.io/packagist/dt/endroid/documenter.svg)](https://packagist.org/packages/endroid/documenter)

[![License](http://img.shields.io/packagist/l/endroid/documenter.svg)](https://packagist.org/packages/endroid/documenter)

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](https://getcomposer.org/) to install the library.

``` bash

composer require endroid/documenter

```

When you use Symfony, the [installer](https://github.com/endroid/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.