tomflidr/apigen

PHP 7.1 source code API generator.

Wednesday, April 4, 2018
by tomFlidr
Repository
1 Watchers
0 Stars
3 Installations

PHP
0 Dependents
0 Suggesters
292 Forks
0 Open issues
20 Versions
0 % Grown

The README.md

Smart and Readable Documentation for your PHP project

, _(*1)

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., _(*2)

Just look at ApiGen API:, _(*3)

ApiGen Preview , _(*4)

Your Help is Needed to Finish 5.x Release

:heart: We need your help to test new version of ApiGen., _(*5)

How to install it?

Add to your composer.json:, _(*6)

{
    "require": {
        "apigen/apigen": "dev-master",
        "roave/better-reflection": "dev-master#c87d856"
    }
}

then update:, _(*7)

composer update

Test it, report issues or send PRs., _(*8)

:skull: Version 4.x is not supported, since there was huge change of Reflection library and the code was almost completely rewritten., _(*9)

Built on Shoulders of Giants

Install

composer require apigen/apigen --dev

Usage

Generate API docs by passing single source and destination options:, _(*10)

vendor/bin/apigen generate src --destination docs

Or generate API docs for multiple directories:, _(*11)

vendor/bin/apigen generate src tests --destination docs

Configuration

Below is a minimal example configuration. Save it as a apigen.yml file in the root of your project:, _(*12)

parameters:
    visibilityLevels: [public, protected] # array
    annotationGroups: [todo, deprecated] # array
    title: "ApiGen Docs" # string
    baseUrl: "http://apigen.org/api" # string
    overwrite: false # bool

What Annotations Have Extra Care?

`@see`, `@covers`, `@uses`

Reference to Class, Function, Property, Method etc. element., _(*13)

In Code, _(*14)

/**
 * @see SomeClass
 * @see SomeClass::$propety
 * @see SomeClass::someFunction()
 */

Generated, _(*15)

@see <a href="class-SomeClass.html">SomeClass</a>
@see <a href="class-SomeClass.html#$someProperty">SomeClass::$property</a>
@see <a href="class-SomeClass.html#_someFunction">SomeClass::someFunction()</a>

`@link`

A website url., _(*16)

In Code, _(*17)

/**
 * This is already mentioned on Wiki.
 * @link https://en.wikipedia.org/wiki/United_we_stand,_divided_we_fall Click to see a cool quote  
 */

Generated, _(*18)

This is already mentioned on Wiki.
@link <a href="https://en.wikipedia.org/wiki/United_we_stand,_divided_we_fall">Click to see a cool quote</a>

`@internal`

Associated element is internal, so ApiGen hides it., _(*19)

Themes

To enable a custom theme just provide themeDirectory configuration option in your apigen.yml:, _(*20)

parameters:
    themeDirectory: path/to/theme # path to theme's config file

Contributing

Rules are simple:, _(*21)

new feature needs tests
all tests must pass bash composer complete-check
1 feature per PR

We would be happy to merge your feature then., _(*22)

The Versions

04/04 2018

v5.0.0-RC6

5.0.0.0-RC6

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

dev-master

9999999-dev

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

dev-performance

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

v5.0.0-RC5

5.0.0.0-RC5

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

v5.0.0-RC4

5.0.0.0-RC4

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

v5.0.0-RC3

5.0.0.0-RC3

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

v5.0.0-RC2

5.0.0.0-RC2

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

v5.0.0-RC1

5.0.0.0-RC1

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

v4.1.2

4.1.2.0 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

v4.1.1

4.1.1.0 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

v4.1.0

4.1.0.0 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

v4.0.1

4.0.1.0 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

v4.0.0

4.0.0.0 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

v4.0.0-RC5

4.0.0.0-RC5 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

andrewsville/php-token-reflection ~1.4
ext-iconv *
ext-json *
ext-mbstring *
ext-tokenizer *
kdyby/console ~2.0
kdyby/events ~2.0
kukulich/fshl ~2.1
latte/latte ~2.2
michelf/php-markdown ~1.4
nette/bootstrap ~2.2
nette/di ~2.3@dev
nette/mail ~2.2
nette/neon ~2.3@dev
nette/robot-loader ~2.2
nette/safe-stream ~2.2
php >=5.4
symfony/options-resolver ~2.6.1
tracy/tracy ~2.2

v4.0.0-RC4

4.0.0.0-RC4 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

andrewsville/php-token-reflection ~1.4
ext-iconv *
ext-json *
ext-mbstring *
ext-tokenizer *
kdyby/console ~2.0
kdyby/events ~2.0
kukulich/fshl ~2.1
latte/latte ~2.2
michelf/php-markdown ~1.4
nette/bootstrap ~2.2
nette/di ~2.2
nette/mail ~2.2
nette/robot-loader ~2.2
nette/safe-stream ~2.2
php >=5.3.1
tracy/tracy ~2.2

v4.0.0-RC3

4.0.0.0-RC3 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

andrewsville/php-token-reflection ~1.4
ext-iconv *
ext-json *
ext-mbstring *
ext-tokenizer *
kdyby/console ~2.0
kdyby/events ~2.0
kukulich/fshl ~2.1
latte/latte ~2.2
michelf/php-markdown ~1.4
nette/bootstrap ~2.2
nette/di ~2.2
nette/mail ~2.2
nette/robot-loader ~2.2
nette/safe-stream ~2.2
php >=5.3.1
tracy/tracy ~2.2

v4.0.0-RC2

4.0.0.0-RC2 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

andrewsville/php-token-reflection ~1.4
ext-iconv *
ext-json *
ext-mbstring *
ext-tokenizer *
kdyby/console ~2.0
kdyby/events ~2.0
kukulich/fshl ~2.1
latte/latte ~2.2
michelf/php-markdown ~1.4
nette/bootstrap ~2.2
nette/di ~2.2
nette/mail ~2.2
nette/robot-loader ~2.2
nette/safe-stream ~2.2
php >=5.3.1
tracy/tracy ~2.2

v4.0.0-RC1

4.0.0.0-RC1 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

andrewsville/php-token-reflection ~1.4
ext-iconv *
ext-json *
ext-mbstring *
ext-tokenizer *
kdyby/console ~2.0
kdyby/events ~2.0
kukulich/fshl ~2.1
latte/latte ~2.2
michelf/php-markdown ~1.4
nette/bootstrap ~2.2
nette/di ~2.2
nette/mail ~2.2
nette/robot-loader ~2.2
nette/safe-stream ~2.2
php >=5.3.1
tracy/tracy ~2.2

v2.8.1

2.8.1.0 http://apigen.org/

API documentation generator for PHP 5.3+

Sources Download

BSD-3-Clause

The Requires

andrewsville/php-token-reflection ~1.3.1
ext-json *
ext-mbstring *
kukulich/fshl ~2.1.0
nette/nette ~2.1.1
php >=5.3.0
texy/texy ~2.4.0

2.8.0

2.8.0.0 http://apigen.org/

API documentation generator for PHP 5.3+

Sources Download

BSD-3-Clause

The Requires

andrewsville/php-token-reflection >=1.3.1
dg/texy >=2.1.0
kukulich/fshl >=2.1.0
nette/nette >=2.0.5
php >=5.3.0

library apigen

PHP 7.1 source code API generator.

tomflidr/apigen

The README.md

Smart and Readable Documentation for your PHP project

Your Help is Needed to Finish 5.x Release

How to install it?

Built on Shoulders of Giants

Install

Usage

Configuration

What Annotations Have Extra Care?

@see, @covers, @uses

@link

@internal

Themes

Contributing

The Versions

v5.0.0-RC6

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

dev-master

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

dev-performance

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

v5.0.0-RC5

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

v5.0.0-RC4

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

v5.0.0-RC3

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

v5.0.0-RC2

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

v5.0.0-RC1

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

v4.1.2

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

`@see`, `@covers`, `@uses`

`@link`

`@internal`