PEAR is archived and read-only

This mirror preserves historical PEAR package releases and metadata so existing references remain available.

Home » Tools and Utilities » PhpDocumentor

The phpDocumentor package provides automatic documenting of php api directly from the source.

This package is unmaintained.

Download latest release 1.5.0a1 (archived versions might be outdated)

License: LGPL

Description

The phpDocumentor tool is a standalone auto-documentor similar to JavaDoc
written in PHP. It differs from PHPDoc in that it is MUCH faster, parses a much
wider range of php files, and comes with many customizations including 11 HTML
templates, windows help file CHM output, PDF output, and XML DocBook peardoc2
output for use with documenting PEAR. In addition, it can do PHPXref source
code highlighting and linking.

Features (short list):
-output in HTML, PDF (directly), CHM (with windows help compiler), XML DocBook
-very fast
-web and command-line interface
-fully customizable output with Smarty-based templates
-recognizes JavaDoc-style documentation with special tags customized for PHP 4
-automatic linking, class inheritance diagrams and intelligent override
-customizable source code highlighting, with phpxref-style cross-referencing
-parses standard README/CHANGELOG/INSTALL/FAQ files and includes them
directly in documentation
-generates a todo list from @todo tags in source
-generates multiple documentation sets based on @access private, @internal and
{@internal} tags
-example php files can be placed directly in documentation with highlighting
and phpxref linking using the @example tag
-linking between external manual and API documentation is possible at the
sub-section level in all output formats
-easily extended for specific documentation needs with Converter
-full documentation of every feature, manual can be generated directly from
the source code with "phpdoc -c makedocs" in any format desired.
-current manual always available at http://www.phpdoc.org/manual.php
-user .ini files can be used to control output, multiple outputs can be
generated at once

**WARNING**:
To use the web interface, you must set PEAR's data_dir to a subdirectory of
document root.

If browsing to http://localhost/index.php displays /path/to/htdocs/index.php,
set data_dir to a subdirectory of /path/to/htdocs:

$ pear config-set data_dir /path/to/htdocs/pear
$ pear install PhpDocumentor

http://localhost/pear/PhpDocumentor is the web interface

Documentation

Manual

Maintainers

Dependencies

Required

Optional

Releases

Bugs

IDStatusTypeVersionDateSummary
#88ClosedBug2003-10-11Template file with wring name
#255ClosedBug2003-11-15missing ressource or typo error
#275BogusBug2003-11-19conflict when using PEAR::Config package
#1012ClosedBug2004-03-14web installation does not work as described in the ChangeLog
#1193BogusBug2004-04-13Comments in code tags improperly formatted
#1902No FeedbackBug2004-07-17PhpDocumentor fails to detect version right
#2077BogusBug2004-08-06PhpDocumentor-1.3.0RC3.tgz missing package.xml
#2122ClosedBug2004-08-14No tree menu for file identifier begining with a number
#2288ClosedBug2004-09-06Webfrontend ignores more than one dir in "Files to ignore"
#2294ClosedBug2004-09-06@toc tag is incompatible when XML prolog exists
#2553DuplicateBug2004-10-18bug in ParserElements.inc on line 238
#2826No FeedbackBug2004-11-25phpdoc command stops without an error
#3766DuplicateBug2005-03-10Fatal error: Cannot re-assign $this in /usr/local/lib/php/PhpDocumentor/phpDocu
#4125ClosedBug2005-04-11E_NOTICE errors
#4960ClosedReq2005-08-01support for different encoding
#5011ClosedBug2005-08-05PDF generation warning on uksort
#5238BogusBug2005-08-29Fatal error: Cannot re-assign $this
#5303BogusBug2005-09-05Last # comment in a <code> block disapears
#5304DuplicateReq2005-09-05You shouldn't need to escape // comments in <code> blocks
#5305BogusBug2005-09-05// comments in <code> blocks are not formated correctly
#5306Wont fixReq2005-09-05{@inheritdoc} doesn't work with implementor of an interface
#5371ClosedBug2005-09-12Getting several "PHP Fatal error: Only variables can be passed by reference"
#5825BogusBug2005-10-29@example not working
#6305ClosedBug1.3.0RC62005-12-20array typehints break the parser
#6306ClosedBug2005-12-20Tokenizer doesn't read "....<%{$key}>..." properly
#6386BogusBug2006-01-01@see in class A cannot refer class B if A::$B exists
#6389ClosedBug2006-01-02Private classes are not used during grouping for class trees
#6423No FeedbackBug2006-01-05many warnings, notices and fatal error
#6457DuplicateBug2006-01-10Single-line DocBlocks cause gaps in syntax highlighting
#6798No FeedbackBug1.3.0RC52006-02-162nd package documentation is empty
#6801DuplicateBug1.3.0RC52006-02-16Fatal Error on parsing nested lists
#6805ClosedBug1.3.0RC52006-02-17Rendering bug for verbatim HTML tags
#6844ClosedBug1.3.0RC52006-02-20phpDocumentor doesn't show classes in file
#6848ClosedBugCVS2006-02-20Reference Patch
#6850ClosedBug1.3.0RC52006-02-21Fatal error in phpDocumentorTParser.inc on line 480
#6952ClosedBug1.3.0RC52006-02-27Update Install docs to tell correct package.xml location
#7001ClosedReq1.3.0RC52006-03-02turn off outbut buffering
#7296No FeedbackBug1.3.0RC52006-04-04Call to a member function cantSource() on a non-object
#7297Wont fixReq1.3.0RC52006-04-04@usedby
#7301Wont fixReq1.3.0RC52006-04-04allow @param tag in page level docblocks
#7325BogusBug1.3.0RC52006-04-06Unclosed pre tag in DocBlock, parsing will be incorrect
#7328BogusBug1.3.0RC52006-04-06Tutorial-Manual appears larger than browser window
#7438No FeedbackBug1.3.0RC52006-04-20@source not working
#7528BogusBug1.3.0RC52006-04-30missconfiguration of app directories
#7548ClosedBug1.3.0RC62006-05-03Notice: Undefined property: _pv_function_param
#7554ClosedBug1.3.0RC62006-05-03Call to undefined method ReflectionClass::hasMethod()
#7563Wont fixReq1.3.0RC62006-05-05Improve memory usage
#7569BogusBug1.2.32006-05-06this pointer assigning
#7577DuplicateBug1.3.0RC62006-05-08Notice error for undefined _pv_function_param property
#7623No FeedbackBug1.3.0RC62006-05-14Correct page level docblock ignored after upgrading to PHP 5.1.4
#7686ClosedBug1.3.0RC62006-05-21phpdoc not run in dos box
#7773Wont fixBug1.3.0RC62006-05-31"nothing parsed" error when parsing in a directory under "tutorials"
#7938ClosedBug1.3.0RC62006-06-19@todo does not work on include elements
#8063Wont fixBug1.3.0RC62006-06-28Notices and uncaught Reflection exception when documenting Gtk2_EntryDialog
#8111ClosedBug1.3.0RC62006-07-04Fatal error: ReflectionClass::hasProperty()
#8290ClosedBug1.3.0RC62006-07-25@param bug when description is on its own line
#8365BogusBug1.3.0RC62006-08-04Fatal Error in HTMLframesConverter.inc
#8443BogusBug1.3.0RC62006-08-15File level API pages are not created
#8520ClosedBug1.3.02006-08-20Broken XML when XML_Beautifier is installed
#8533ClosedBug1.3.02006-08-22require() broken in a lot of places - cannot run!
#8539ClosedBug1.3.02006-08-23Parser error in create_examples.php
#8746ClosedBug1.3.02006-09-20XML:DocBook generates warning with function/parameters without @param tag
#8773ClosedBug1.3.02006-09-23PDF Convertor fails due to being unable to find fonts
#8914ClosedBug1.3.02006-10-09returning non varibale reference ParserData.inc#500
#9129Wont fixReq1.3.02006-10-21XHTML pages being parsed as PHP
#9151ClosedBug1.3.12006-10-24ReflectionException when documenting classes derived from PHP internal classes
#9250No FeedbackBug1.3.12006-11-06--templatebase does not function as expected
#9365BogusBug1.3.12006-11-17.spec file incorrectly references the file package2.xml instead of package.xml
#9366ClosedBug1.3.12006-11-17Last line with comment in <code> disappears
#9619No FeedbackBug1.3.12006-12-14E_WARNING: strpos(): Empty delimiter
#9673ClosedBug1.3.12006-12-21potential major security issue
#9915ClosedBug1.3.12007-01-22PHP Notice in PDF Converter
#9937ClosedBug1.3.12007-01-24Security Exploit CVE-2005-4593
#10266ClosedBugCVS2007-03-05List in @todo tags not processed correctly
#10289ClosedBug1.3.12007-03-06Hangs at "Converting tutorials"
#10558Wont fixBugCVS2007-03-29Extra Leading Space in Sourcode View
#10588Wont fixReq1.3.12007-04-02Removable line numbers option
#10640Wont fixReqCVS2007-04-06split up converters into separate packages
#10670ClosedReq1.3.12007-04-09Don't Die on Empty Tag Descriptions
#10675ClosedDoc1.3.12007-04-09Clear some errors.html items
#10730ClosedDoc1.3.22007-04-15Replace Sourceforge Trackers with PEAR
#10750Wont fixReq1.3.22007-04-16Better USES/USEDBY Sorting
#10864ClosedBug1.4.0a12007-04-27PhpDocumentor dies when parsing illegal page-level docblock
#10870ClosedBug1.4.0a12007-04-28Dead links generated with HTML:Smarty:Php
#10871ClosedBug1.4.0a12007-04-28Wrong rendering of inline {@internal}}
#10909ClosedBug1.3.22007-05-02PHP Notice in PDF Converter line 210
#10910ClosedBug1.3.22007-05-02DOM templates create incorrect trees
#10914ClosedDoc1.4.0a12007-05-03Can't use nested tags inside <kbd> or <samp>
#10972ClosedDoc1.4.0a12007-05-07@method does not work
#10996Wont fixReq1.4.0a12007-05-09@tests tag to show unit test coverage
#11032ClosedDoc1.4.0a12007-05-14param type1|type2 not documented
#11136Wont fixReq1.3.22007-05-25@return should accept functions/methods/propertys
#11137Wont fixReq1.3.22007-05-25@uses should differ between static and object
#11139No FeedbackBug1.3.22007-05-25'located in' link to wrong file if @package differs
#11143ClosedDoc1.4.0a12007-05-25Provide a Minimal Tutorial File Setup Example
#11409ClosedBug1.4.0a22007-06-22PHP Notices accompany Global Never Found errors
#11503Wont fixReqCVS2007-07-02document direct output
#11540Wont fixBug1.4.0RC12007-07-06inline @static tag renders wrong result with XML:DocBook/peardoc2:default
#11543ClosedBug1.3.22007-07-06empty @todo tags/comments shouldn't be included in TODO list
#11606ClosedDocirrelevant2007-07-14Documentation's links are broken
#11613ClosedBug1.4.0RC22007-07-16-q flag is not honoured
#11617ClosedBug2007-07-16API Documentation generated strange
#11618Wont fixReq1.4.0RC22007-07-16@uses privateMember should suppress itself when--parseprivate OFF
#11629BogusBug1.4.0RC22007-07-17a test bug
#11654ClosedBug1.4.0RC22007-07-20@static in DocBlock Template can cause PHP Notice
#11683ClosedBug1.4.02007-07-25examples displayed using earthli style are not rendered properly
#11755ClosedReq1.4.02007-08-04Remove Unused DocBlock_Lexer and PHPT Tests
#11757ClosedReq1.4.02007-08-04Move PhpUnit Tests into new tests dir
#11787ClosedBug1.4.02007-08-07ERROR: Nothing Parsed
#11788ClosedBug1.4.02007-08-08Two failing unit tests
#11794Wont fixReq1.4.02007-08-08Load config file from any path
#11799Wont fixReq1.4.02007-08-08Config validity check
#11809ClosedBug1.4.02007-08-09Incorrect @name usage causes fatal crash
#11833Wont fixReq1.4.02007-08-13Config File Allow Commandline Overrides
#11847Wont fixReq1.4.02007-08-15Add new HTML:Smarty:pearweb converter
#11943Wont fixReq1.4.02007-08-30Utilize @assert tags when present for PhpUnit
#12094BogusBug1.4.02007-09-21:: used in docblock <code> acts like @see
#12100Wont fixReq1.4.02007-09-23Referring to inherited methods
#12121ClosedBug1.4.02007-09-26phpdoc.bat cannot launch php.exe
#12128DuplicateReq1.4.02007-09-27support encoding in templates
#12172ClosedBug1.4.02007-10-02media files are not being copied
#12199Wont fixReq1.4.02007-10-08specify return type for arrays
#12201ClosedBug1.4.02007-10-08Misleading error message
#12203Wont fixBug1.4.02007-10-08Global-Datatype-Description adds extra '0'
#12211ClosedDoc1.4.02007-10-09@inheritdoc not working for child methods & variables
#12234Wont fixReq1.4.02007-10-12support highlighting values like NULL, TRUE and FALSE
#12236ClosedReq1.4.02007-10-12Allow RIC files in all directory
#12360Wont fixBug1.4.02007-10-30wrong rendering of var arrays, if a key is an array
#12361ClosedBug1.4.02007-10-30missing links to the filesource
#12459ClosedDoc1.4.02007-11-16@subpackage does not fix name conflicts
#12536Wont fixReq1.4.02007-11-27The errors.html should be xml compliant
#12577Wont fixBug1.4.02007-12-02incorrect/incomplete license in package.xml
#12626DuplicateBug1.4.02007-12-06IO Class is causing doc render to make incorrect file copy path
#12699ClosedBug1.4.12007-12-15makedocs.sh script needs a better install location
#12704ClosedBug1.4.12007-12-16XML/Beautifier removed comment in XML Docbook peardoc2 converter template
#12733ClosedBug1.4.12007-12-19Warning in error.html file with XML:DocBook:peardoc2
#12764ClosedDoc1.4.12007-12-22Update INSTALL for web docbuilder
#12929ClosedBug1.4.12008-01-18paramete 'ignore' oper mistake
#13351Wont fixReq1.4.12008-03-08Bundled smarty needs security update
#13599ClosedDoc1.4.22008-04-05Third Gotcha on Bare Minimum Tutorial example
#13606ClosedBug2008-04-05parameter name and description do not line up in generated docs
#13653ClosedBug1.4.22008-04-11Media file copy - copies incorrect file
#13671DuplicateBug1.4.22008-04-14Error with new template directory (outside the default template base)
#13744Wont fixReq1.4.22008-04-22The class constants can't be refered by @see or @link etc.
#13745Wont fixReq1.4.22008-04-22Improve Tokenizer Checking Code
#13800ClosedBug1.4.22008-04-29Invalid tutorials tree generation
#14159Wont fixBug2008-06-17PhpDocumentor doesn't detect interfaces in @subpackage
#14177No FeedbackBug1.4.22008-06-18phpDocumnetor is including itself in final project
#14184Wont fixReqCVS2008-06-19document script termination
#14185Wont fixReqCVS2008-06-19docuemnt special meaning function
#14191ClosedBugCVS2008-06-19earthli template contains bad HTML
#14201ClosedBug1.4.22008-06-20templatebase not working as intended
#14244Wont fixReq1.4.22008-06-26make warning about missing class package optional
#14305Wont fixBug1.4.22008-07-07Missing/incomplete result for XML DocBook renderer and @return tag
#14312ClosedDoc1.4.22008-07-08@param tag with additional arguments doesn't work as expected
#14461ClosedDoc1.4.22008-08-06Data Type Confusion for Some Tags
#14472ClosedBug1.4.22008-08-07Incorrect line numbers with heredoc
#14580Wont fixReq1.4.22008-08-30Support for documenting Javascript Files
#14640ClosedBug1.4.22008-09-12class witch extending DOMDocument
#14981Wont fixReq2008-11-10"Documentation for the latest release" link for php_parser is broken
#15004Wont fixBugCVS2008-11-12Parse error in tests
#15109Wont fixReq2008-11-21Mutliple @var tags not allowed
#15267BogusBug2008-12-07Not a class
#15517ClosedBug1.4.22009-01-05Wrong table of contents in tutorials
#15580ClosedReq2009-01-09Add link back from api document to pear website or package website
#16210Wont fixReq1.4.22009-05-09DocBlocks interfere with code folding
#16223Wont fixReq1.4.22009-05-13Support for fluent / chain methods in PHPDoc.
#16270Wont fixReq1.4.22009-05-29<code> should generate inline, not block HTML
#16279ClosedBug1.4.02009-06-02Type Hints in Function Signature Cause Loss of @param type
#16333Wont fixReqUnknown2009-06-16@var tag documentation should be formatted better
#16431ClosedBug1.4.22009-07-12Warning: get_class() expects parameter 1 to be object, string given
#16441ClosedBug1.4.22009-07-15Parse error when parsing <<foo>>
#16446ClosedBug1.4.22009-07-17Use of split() causes E_DEPRECATED warnings
#16542Wont fixBug1.4.22009-08-20Very random " duplicate class element " Error
#16546ClosedBug1.4.22009-08-23Default parser uses php 4.0 standards
#16622DuplicateBug1.4.32009-09-17Undefined property: HTMLframesConverter::$class_data
#16784ClosedBug1.4.32009-11-13CHM: files are duplicated in the [FILES] section of the project file.
#16825ClosedBug1.4.32009-11-23Templates Point to Nonexistent Image Files
#16826ClosedBug1.4.32009-11-23Unused media folder and files exist
#17011Wont fixReq1.4.32010-01-18Add option to ignore missing parent class
#17124No FeedbackReq1.4.32010-02-17validation of documentation, instead of HTML rendering
#17176Wont fixReq1.4.32010-03-01phpdoc doesn't understand namespaces
#17187Wont fixBug1.4.32010-03-03Long arrays as properties don't wrap
#17200Wont fixBug1.4.32010-03-06Several Errors during execution.
#17213BogusDoc1.4.32010-03-11Copying images/css problem - cutting last letter file extension
#17340Wont fixBug1.4.32010-04-24Bad Links From Class To File In Subpackages
#17341DuplicateBug1.4.32010-04-24Bad Links From Class To File In Subpackages
#17342No FeedbackBug1.4.32010-04-25Default Frame Template Contains Broken Image Refs
#17346No FeedbackBugUnknown2010-04-26PHPDoc doesnot parse out the description in a class
#17347BogusDoc1.4.32010-04-26500 Status in documentation for @var
#17395ClosedBug1.4.32010-05-13Fatal Error when trying to run document
#17538Wont fixReq1.4.32010-06-30Multiple signatures for function/method
#17690Wont fixBugSVN2010-08-10Patch: deprecation of set_magic_quotes_runtime
#17807Wont fixReq1.4.32010-08-24Erroneous message "duplicate class element" when using static keyword
#17906ClosedReq1.4.32010-09-29Please, consider realising 'Plain.php' file under PHP 3.01 license
#18058ClosedBug1.4.32010-11-15Patch: fix some notices (which may cause a crash of other tools)
#18100ClosedBug1.4.32010-12-07phpdocu-general@sourceforge.net bounces
#18220ClosedBug1.4.32011-01-25Truncated filenames in Converter files
#18223Wont fixBug1.4.32011-01-27--directory doesn't recognise all valid path formats
#18416Wont fixReq1.4.32011-03-31Type hinting fails for pre-defined classes
#18470Wont fixReq1.4.32011-04-21Allow for 'long' open/close docblock lines
#18782ClosedBugSVN2011-09-03class tree generation mistake
#18870ClosedBugSVN2011-09-25Class tree wont shows implemented interfaces if class has no childs
#18871ClosedBugSVN2011-09-25Class tree wont shows internal PHP interfaces
#18872ClosedBugSVN2011-09-25Class tree puts comma uncorrectly in interfaces list
#19017ClosedBugSVN2011-11-14remove error_reporting (for PEAR QA team)
#19047Wont fixBug1.4.32011-11-15heredoc and nowdoc in code block stops highlighting
#19059Wont fixBug1.4.32011-11-19phpDocumentor doesn't parse <pre> tags
#19197ClosedBug1.4.42012-01-05Fatal Error on building documentation
#19242ClosedReq1.4.42012-01-23Allow images in tutorials
#19243ClosedBug1.4.42012-01-23Tutorials are not honoring ordered vs unordered lists
#19244Wont fixBug1.4.42012-01-23Reference (&) in method signature throws off argument parsing
#19245Wont fixReq1.4.42012-01-23Allow explicit @access tags to override actual code keywords
#19391Wont fixBug1.4.42012-04-20frames converter died when generating left index w/ tutorials
#19410ClosedBugSVN2012-05-06Sourcecode Option does not work
#20024Wont fixBug1.5.0a12013-07-26Undefined property DocBlockTags.inc on line 1356
#20271BogusDoc1.4.42014-05-10Occurs many errors on documentation
#21102Wont fixBug1.5.0a12016-08-18not compatible with PHP7
#21234OpenBug1.4.42017-08-02Strict standard violations