Download the PHP package tomflidr/apigen without Composer
On this page you can find all versions of the php package tomflidr/apigen. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package apigen
Smart and Readable Documentation for your PHP project
ApiGen is the simplest, the easiest to use and the most modern api doc generator. It is all PHP 7.1 features ready easy to extend with own Finder, Annotation Subscriber or even Generator.
Just look at ApiGen API:
Your Help is Needed to Finish 5.x Release
:heart: We need your help to test new version of ApiGen.
How to install it?
Add to your composer.json
:
then update:
Test it, report issues or send PRs.
:skull: Version 4.x is not supported, since there was huge change of Reflection library and the code was almost completely rewritten.
Built on Shoulders of Giants
- PHP 7.1+
- nikic/PHP-Parser
- Roave/BetterReflection
- phpDocumentor/TypeResolver
- phpDocumentor/ReflectionDocBlock
Install
Usage
Generate API docs by passing single source and destination options:
Or generate API docs for multiple directories:
Configuration
Below is a minimal example configuration. Save it as a apigen.yml
file in
the root of your project:
What Annotations Have Extra Care?
@see
, @covers
, @uses
Reference to Class, Function, Property, Method etc. element.
In Code
Generated
@link
A website url.
In Code
Generated
@internal
Associated element is internal, so ApiGen hides it.
Themes
To enable a custom theme just provide themeDirectory
configuration option in your apigen.yml
:
Contributing
Rules are simple:
- new feature needs tests
-
all tests must pass
- 1 feature per PR
We would be happy to merge your feature then.
All versions of apigen with dependencies
roave/better-reflection Version dev-master#a402048
phpdocumentor/reflection-docblock Version ^3.1
kukulich/fshl Version ^2.1
latte/latte Version ^2.4
nette/utils Version ^2.4
nette/finder Version ^2.4
nette/neon Version ^2.4
symfony/config Version ^3.3
symfony/console Version ^3.3
symfony/finder Version ^3.3
symfony/dependency-injection Version ^3.3
symfony/http-kernel Version ^3.3
symfony/yaml Version ^3.3
symplify/package-builder Version ^2.2
psr/container Version ^1.0
zendframework/zend-code Version ^3.1