phpDocumentor is an
open-source
Open source is source code that is made freely available for possible modification and redistribution. Products include permission to use the source code, design documents, or content of the product. The open-source model is a decentralized sof ...
documentation generator
A documentation generator is a programming tool that generates software documentation intended for programmers (API documentation) or end users (end-user guide), or both, from a set of source code files, and in some cases, binary files. Some genera ...
written in
PHP
PHP is a general-purpose scripting language geared toward web development. It was originally created by Danish-Canadian programmer Rasmus Lerdorf in 1993 and released in 1995. The PHP reference implementation is now produced by The PHP Group ...
. It automatically parses PHP
source code
In computing, source code, or simply code, is any collection of code, with or without comments, written using a human-readable programming language, usually as plain text. The source code of a program is specially designed to facilitate the wo ...
and produces readable
API
An application programming interface (API) is a way for two or more computer programs to communicate with each other. It is a type of software Interface (computing), interface, offering a service to other pieces of software. A document or standa ...
and source code documentation, based on
PHPDoc
PHPDoc is an adaptation of Javadoc for the PHP programming language. It is still an informal standard for commenting PHP code, but it is in the process of being formalized.PHP-FIG: PSR Working Draft - https://github.com/php-fig/fig-standards/blob/ ...
-formatted comments and the structure of the source code itself. It supports documentation of both
object-oriented
Object-oriented programming (OOP) is a programming paradigm based on the concept of "objects", which can contain data and code. The data is in the form of fields (often known as attributes or ''properties''), and the code is in the form of pro ...
and
procedural code. phpDocumentor runs at the
command line
A command-line interpreter or command-line processor uses a command-line interface (CLI) to receive commands from a user in the form of lines of text. This provides a means of setting parameters for the environment, invoking executables and pro ...
to create documentation in
HTML
The HyperText Markup Language or HTML is the standard markup language for documents designed to be displayed in a web browser. It can be assisted by technologies such as Cascading Style Sheets (CSS) and scripting languages such as JavaScri ...
format. It has support for linking between documentation, incorporating user level documents like tutorials, and creation of highlighted source code with cross referencing to PHP general documentation.
phpDocumentor 1.x could parse PHP syntax of PHP 4 up to PHP 5.2.
In March 2012, the DocBlox project merged with the 1.x branch of phpDocumentor, resulting in the new major version release of phpDocumentor 2. The first
alpha
Alpha (uppercase , lowercase ; grc, ἄλφα, ''álpha'', or ell, άλφα, álfa) is the first letter of the Greek alphabet. In the system of Greek numerals, it has a value of one. Alpha is derived from the Phoenician letter aleph , whic ...
was released on March 16, 2012. phpDocumentor 2.x supported syntax for PHP 5.3 up to 7.0.
The 3.0 major version release occurred on October 27, 2020.
This brought PHP syntax readability up to 7.4.
See also
*
Comparison of documentation generators
The following tables compare general and technical information for a number of documentation generators. Please see the individual products' articles for further information. Unless otherwise specified in footnotes, comparisons are based on the s ...
*
PHPDoc standard for commenting PHP code
External links
*
References
Free documentation generators
PHP software
{{programming-software-stub