PhpDocumentor
Encyclopedia
phpDocumentor is an open source
documentation generator
written in PHP
. It automatically parses PHP source code
and produces readable API
and source code documentation in a variety of formats. phpDocumentor generates documentation based on PHPDoc
-formatted comments and the structure of the source code itself. It supports documentation of both object-oriented and procedural
code. phpDocumentor can create documentation in HTML
, PDF
, CHM or Docbook
formats. It can be used from the command line or via a web interface. 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 is able to parse all PHP syntax and supports PHP4 and PHP5. It is an open source project and is distributed under the terms of the GNU Lesser General Public License
(LGPL).
The latest release has no support for namespaces and other sought after PHP 5.3 features. As of November 2010, it is no longer actively maintained.
Open source
The term open source describes practices in production and development that promote access to the end product's source materials. Some consider open source a philosophy, others consider it a pragmatic methodology...
documentation generator
Documentation generator
A documentation generator is a programming tool that generates documentation intended for programmers or end users , or both, from a set of specially commented source code files, and in some cases, binary files....
written in PHP
PHP
PHP is a general-purpose server-side scripting language originally designed for web development to produce dynamic web pages. For this purpose, PHP code is embedded into the HTML source document and interpreted by a web server with a PHP processor module, which generates the web page document...
. It automatically parses PHP source code
Source code
In computer science, source code is text written using the format and syntax of the programming language that it is being written in. Such a language is specially designed to facilitate the work of computer programmers, who specify the actions to be performed by a computer mostly by writing source...
and produces readable API
Application programming interface
An application programming interface is a source code based specification intended to be used as an interface by software components to communicate with each other...
and source code documentation in a variety of formats. phpDocumentor generates documentation based on PHPDoc
PHPDoc
PHPDoc is an adaptation of Javadoc for the PHP programming language. It is a formal standard for commenting PHP code. It allows external document generators like phpDocumentor to generate documentation of APIs and helps some IDEs such as Zend Studio, NetBeans, JetBrains PhpStorm, ActiveState...
-formatted comments and the structure of the source code itself. It supports documentation of both object-oriented and procedural
Procedural programming
Procedural programming can sometimes be used as a synonym for imperative programming , but can also refer to a programming paradigm, derived from structured programming, based upon the concept of the procedure call...
code. phpDocumentor can create documentation in HTML
HTML
HyperText Markup Language is the predominant markup language for web pages. HTML elements are the basic building-blocks of webpages....
Portable Document Format
Portable Document Format is an open standard for document exchange. This file format, created by Adobe Systems in 1993, is used for representing documents in a manner independent of application software, hardware, and operating systems....
, CHM or Docbook
DocBook
DocBook is a semantic markup language for technical documentation. It was originally intended for writing technical documents related to computer hardware and software but it can be used for any other sort of documentation....
formats. It can be used from the command line or via a web interface. 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 is able to parse all PHP syntax and supports PHP4 and PHP5. It is an open source project and is distributed under the terms of the GNU Lesser General Public License
GNU Lesser General Public License
The GNU Lesser General Public License or LGPL is a free software license published by the Free Software Foundation . It was designed as a compromise between the strong-copyleft GNU General Public License or GPL and permissive licenses such as the BSD licenses and the MIT License...
(LGPL).
The latest release has no support for namespaces and other sought after PHP 5.3 features. As of November 2010, it is no longer actively maintained.
See also
- Comparison of documentation generators
- PHPDoc standard for commenting PHP codePHPDocPHPDoc is an adaptation of Javadoc for the PHP programming language. It is a formal standard for commenting PHP code. It allows external document generators like phpDocumentor to generate documentation of APIs and helps some IDEs such as Zend Studio, NetBeans, JetBrains PhpStorm, ActiveState...