Wallogit.com 2017 © Pedro Peláez

Home
Sign in
- Email address
  
  Password
  
  Remember me

library apigen

PHP 7.1 source code API generator.

apigen/apigen

PHP 7.1 source code API generator.

Monday, April 23, 2018
by jadb
Repository
105 Watchers
1782 Stars
413,440 Installations

PHP
307 Dependents
7 Suggesters
297 Forks
44 Open issues
24 Versions
4 % Grown

The README.md

Smart and Readable Documentation for PHP projects

ApiGen is easy to use and modern API doc generator supporting all PHP 8.3 features., _(*1)

Features

phpDoc
PHP 8.3
- typed class constants
PHP 8.2
PHP 8.1
PHP 8.0
PHP 7.4
- typed properties
PHP 7.2
- object type
PHP 7.1
PHP 7.0
- scalar types
- return types
PHP 5.6
- constant scalar expressions
- variadic functions
PHP 5.4

Built on Shoulders of Giants

Install

With Docker

ApiGen is available as apigen/apigen Docker image which you can directly use., _(*2)

docker run --rm --interactive --tty --volume "$PWD:$PWD" --workdir "$PWD" \
  apigen/apigen:edge \
  src --output docs

With Phar

This will install ApiGen phar binary to tools/apigen., _(*3)

mkdir -p tools
curl -L https://github.com/ApiGen/ApiGen/releases/latest/download/apigen.phar -o tools/apigen
chmod +x tools/apigen
tools/apigen src --output docs

With Composer

This will install ApiGen to tools/apigen directory with executable entry point available in tools/apigen/bin/apigen., _(*4)

composer create-project --no-dev apigen/apigen:^7.0@alpha tools/apigen
tools/apigen/bin/apigen src --output docs

Usage

Generate API docs by passing source directories and destination option:, _(*5)

apigen src --output docs

Configuration

ApiGen can be configured with apigen.neon configuration file., _(*6)

parameters:
  # string[], passed as arguments in CLI, e.g. ['src']
  paths: []

  # string[], --include in CLI, included files mask, e.g. ['*.php']
  include: ['*.php']

  # string[], --exclude in CLI, excluded files mask, e.g. ['tests/**']
  exclude: []

  # bool, should protected members be excluded?
  excludeProtected: false

  # bool, should private members be excluded?
  excludePrivate: true

  # string[], list of tags used for excluding class-likes and members
  excludeTagged: ['internal']

  # string, --output in CLI
  outputDir: '%workingDir%/api'

  # string | null, --theme in CLI
  themeDir: null

  # string, --title in CLI
  title: 'API Documentation'

  # string, --base-url in CLI
  baseUrl: ''

  # int, --workers in CLI, number of processes that will be forked for parallel rendering
  workerCount: 8

  # string, --memory-limit in CLI
  memoryLimit: '512M'

The Versions

23/04 2018

dev-master

9999999-dev

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

by ApiGen Contributors

api generator documentation phpdoc

26/09 2017

dev-nelson

dev-nelson

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

04/09 2017

dev-performance

dev-performance

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

31/08 2017

v5.0.0-RC5

5.0.0.0-RC5

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

27/08 2017

dev-better-parse-exception

dev-better-parse-exception

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

10/08 2017

dev-cs-update

dev-cs-update

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

03/08 2017

v5.0.0-RC4

5.0.0.0-RC4

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

16/07 2017

v5.0.0-RC3

5.0.0.0-RC3

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

03/07 2017

v5.0.0-RC2

5.0.0.0-RC2

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

17/06 2017

v5.0.0-RC1

5.0.0.0-RC1

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

10/06 2017

dev-description

dev-description

PHP 7.1 source code API generator.

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by ApiGen Contributors

27/03 2017

4.2.x-dev

4.2.9999999.9999999-dev http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

api generator documentation phpdoc

29/11 2015

v4.1.2

4.1.2.0 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

by Olivier Laviale

api generator documentation phpdoc

09/04 2015

v4.1.1

4.1.1.0 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

by Olivier Laviale

api generator documentation phpdoc

04/04 2015

v4.1.0

4.1.0.0 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

by Olivier Laviale

api generator documentation phpdoc

09/03 2015

v4.0.1

4.0.1.0 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

by Olivier Laviale

api generator documentation phpdoc

03/01 2015

v4.0.0

4.0.0.0 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

by Olivier Laviale

api generator documentation phpdoc

17/12 2014

v4.0.0-RC5

4.0.0.0-RC5 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

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

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

by Olivier Laviale

api generator documentation phpdoc

09/11 2014

v4.0.0-RC4

4.0.0.0-RC4 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

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

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

by Olivier Laviale

api generator documentation phpdoc

09/10 2014

v4.0.0-RC3

4.0.0.0-RC3 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

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

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

by Olivier Laviale

api generator documentation phpdoc

05/10 2014

v4.0.0-RC2

4.0.0.0-RC2 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

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

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

by Olivier Laviale

api generator documentation phpdoc

02/10 2014

v4.0.0-RC1

4.0.0.0-RC1 http://apigen.org/

PHP source code API generator

Sources Download

MIT

The Requires

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

The Development Requires

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

by Tomáš Votruba

by Olivier Laviale

api generator documentation phpdoc

01/09 2014

v2.8.1

2.8.1.0 http://apigen.org/

API documentation generator for PHP 5.3+

Sources Download

BSD-3-Clause

The Requires

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

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

api generator documentation phpdoc phpdocumentor docblock

29/09 2012

2.8.0

2.8.0.0 http://apigen.org/

API documentation generator for PHP 5.3+

Sources Download

BSD-3-Clause

The Requires

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

by David Grudl

by Ondřej Nešpor

by Jaroslav Hanslík

api generator documentation phpdoc phpdocumentor docblock