ApiGen API documentation generator for PHP 5.3+

Fork ApiGen

ApiGen is the tool for creating professional API documentation from PHP source code, similar to phpDocumentor.

ApiGen has support for PHP 5.3 namespaces, packages, linking between documentation, cross referencing to PHP standard classes and general documentation, creation of highlighted source code and experimental support for PHP 5.4 traits.

Take a look at an example.

ApiGen uses a Nette Framework templating system and Markdown Markup to produce useful and easy to read HTML documentation, FSHL to create highlighted source code and TokenReflection to describe the documented source code.

• Our own TokenReflection library is used to describe the source code. It is safe (documented source code does not get included and thus parsed) and simple (you do not need to include or autoload all libraries you use in your source code).
• Detailed documentation of classes, functions and constants.
• Highlighted source code.
• Support of namespaces and packages with subpackages.
• Experimental support of traits.
• A page with trees of classes, interfaces, traits and exceptions.
• A page with a list of deprecated elements.
• A page with Todo tasks.
• Link to download documentation as ZIP archive.
• Checkstyle report of poorly documented elements.
• Support for docblock templates.
• Support for @inheritdoc.
• Support for {@link}.
• Active links in @see and @uses tags.
• Documentation of used internal PHP classes.
• Links to the start line in the highlighted source code for every described element.
• List of direct and indirect known subclasses, implementers and users for every class/interface/trait/exception.
• Check for a new version.
• Google CSE support with suggest.
• Google Analytics support.
• Support for multiple/custom templates.
• Sitemap and opensearch support.
• Support for different charsets and line endings.
• Highly customizable with lots of configuration options (see below).

See readme on Github

We are generating documentation for the Kdyby components We want Nette and Doctrine to be parsed as well because we want their classes to appear in class trees, lists of parent classes and their members in lists of inherited properties, methods and constants. However we do not want to generate their full documentation along with highlighted source codes. And we do not want to process any "test" directories, because there might be classes that do not belong to the project actually.

We create apigen.neon with settings:

destination ../docs

source:
	- vendor/kdyby
	- vendor/doctrine
	- vendor/nette
	- vendor/symfony

skip-doc-path: "~/doctrine2/*"
skip-doc-prefix: Nette

exclude: "*/tests/*"
title: "Kdyby"

apigen.phar

For bug reports and issues use repository issues. Changes between versions are described in releases.

ApiGen is distributed for free. If you really like it and want to support its developers or if you want to support a particular feature to be implemented, you can send a small donation using your credit/debit card by clicking on the button bellow. The actual amount is fully up to you.

Thank you.

• GitHub repository
• Issues
• Twitter