Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Smart and Readable Documentation for your PHP project
PHP Other

README.md

Smart and Readable Documentation for your PHP project

Build Status Quality Score Code Coverage Downloads this Month Latest stable

Just look at Doctrine ORM API.

Features

And much more...

Requirements

  • PHP 5.4

Installation

1. As a PHAR (recommended)

  1. Download ApiGen

  2. Run ApiGen with source and destination options:

php apigen.phar generate -s src -d ../my-project-api

To omit cli options just create apigen.neon file in your project using Neon syntax.

source:
    - src

destination: ../my-project-api

For global installation, see documentation.

2. Using Composer as dependency of your project

composer require apigen/apigen --dev

Then run with options as above:

php vendor/bin/apigen generate -s src -d ../my/project-api

Options

To see all available options with it's description and default values, just run:

apigen generate --help

Note: in apigen.neon is prefered camel case (accessLevel) over dash-case in CLI (--access-level).

If you want to know what annotations do we support, here is the list.

Testing

$ phpunit

Contributing

Please see CONTRIBUTING for details.

Something went wrong with that request. Please try again.