Smart and Readable Documentation for your PHP project

Requirements

The best way to install ApiGen is via composer:

composer require apigen/apigen --dev

Installation via create-project is also possible.

Run ApiGen with source and destination options:

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

To omit cli options just create apigen.yaml (or apigen.neon) file in your project. *.dist versions are also supported.

source:
	- src
	- vendor/some/package

destination: ../my-project-api

Then run with options as above:

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

That's it!

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.

$ phpunit

Please see CONTRIBUTING for details.