Repository files navigation

Just look atCakePHP Framework orDoctrine ORM API.

• PHP 7.0

In your project's root folder:

composer require --dev apigen/apigen

Or if you want it globally:

composer global require --dev apigen/apigen

In your project's root folder:

curl -L -O https://github.com/ApiGen/ApiGen.github.io/raw/master/apigen.phar

(or just download ithere).

For global installation, just move the downloadedapigen.phar to your path.

NOTE: The above examples assume you have ApiGen installed in your path. You might need to change theapigen command tovendor/bin/apigen if installed locally through Composer orphp apigen.pharif using the PHAR version.

Run ApiGen with source and destination options:

apigen generate -s ./src -d ./docs

To omit cli options just createapigen.yaml orapigen.neon file in your project's root folder:

source:    -./srcdestination:./docs

For all available options, along with descriptions and default values, just run:

apigen generate --help

NOTE: In config files, options are camelCased (i.e.accessLevel for--access-level).

Refer to thewiki for all supported annotations.

$ phpunit

• #apigen on irc.freenode.net - Come chat with us, we have cake.

• GitHub Issues - Got issues? Please tell us!

• Roadmaps - Want to contribute? Get involved!

Please refer toCONTRIBUTING for details.