[ANNOUNCEMENT] PhpDocumentor-1.3.0RC6 (beta) Released.

The new PEAR package PhpDocumentor-1.3.0RC6 (beta) has been released at http://pear.php.net/. Release notes ------------- PHP 5 support and more, fix bugs This release fixes a large number of bugs, and switches to the LGPL license instead of the PHP License. This will be the last release in the 1.x series. 2.0 is next Features added to this release include: * Full PHP 5 support, phpDocumentor both runs in and parses Zend Engine 2 language constructs. Internal classes are recognized and inheritance is documented. Note that you must be running phpDocumentor in PHP 5 in order to parse PHP 5 code * XML:DocBook/peardoc2:default converter now beautifies the source using PEAR's XML_Beautifier if available * inline {@example} tag - this works just like {@source} except that it displays the contents of another file. In tutorials, it works like <programlisting> * customizable README/INSTALL/CHANGELOG files * phpDocumentor tries to run .ini files out of the current directory first, to allow you to put them anywhere you want to * multi-national characters are now allowed in package/subpackage names * images in tutorials with the <graphic> tag * un-modified output with <programlisting role="html"> * html/xml source highlighting with <programlisting role="tutorial"> From both Windows and Unix, both the command-line version of phpDocumentor and the web interface will work out of the box by using command phpdoc - guaranteed :) WARNING: in order to use the web interface through PEAR, you must set your data_dir to a subdirectory of your document root. $ pear config-set data_dir /path/to/public_html/pear on Windows with default apache setup, it might be C:\> pear config-set data_dir "C:\Program Files\Apache\htdocs\pear" After this, install/upgrade phpDocumentor $ pear upgrade phpDocumentor and you can browse to: http://localhost/pear/PhpDocumentor/ for the web interface ------ WARNING: The PDF Converter will not work in PHP5. The PDF library that it relies upon segfaults with the simplest of files. Generation still works great in PHP4 ------ - WARNING: phpDocumentor installs phpdoc in the scripts directory, and this will conflict with PHPDoc, you can't have both installed at the same time - Switched to Smarty 2.6.0, now it will work in PHP 5. Other changes made to the code to make it work in PHP 5, including parsing of private/public/static/etc. access modifiers - fixed these bugs: [ not entered ] phpdoc script broken on unix [ not entered ] XMLDocBookpeardoc2 beautifier removes comments [ 893186 ] HTMLframes converter sometimes misses package level docs [ 896444 ] Bad line numbers [ 907734 ] Exception Class is builtin to PHP5 [ 924760 ] source rendering in FireFox contains extra newlines [ 937235 ] duplicated /** after abstract method declaration [ 944149 ] Apostrophe in DocBook name breaks DOM/earthli tree index [ 952217 ] HTML:frames:earthli [ 962319 ] Define : don't show the assigned value [ 964248 ] Convert invalid characters in package/subpackage names to _ [ 977674 ] Parser error [ 986622 ] parserClass::setModifiers is incorrecrly documented [ 989258 ] wrong interfaces parsing [ 995731 ] {@internal}}-tag shows }} in HTML-doc [ 1016927 ] no highlight for paramtype in header of function [ 1043330 ] Make Command Line Parser support shorter syntax [ 1044486 ] duplicate parameters [ 1046856 ] Small filesource link bug under windows [ 1051941 ] private variables on same line not recognized [ 1079637 ] Use of realpath() leads to empty $dir [ 1081396 ] Display of inline {@link} tags with PHP functions [ 1090009 ] @uses doesn't generate @usedby link when linking to file.ext [ 1108018 ] Bad source code after /**#@-*/ [ 1145403 ] Call to a member function on a non-object [ 1150809 ] Infinite loop when class extends itself [ 1151196 ] PHP Fatal error: Cannot re-assign $this [ 1151650 ] UTF8 decoding for DocBook packages [ 1152286 ] 1.3.0RC3 - PHP5 - Smarty template doesn't work properly? [ 1152316 ] 1.3RC3 - PHP5 - HTML:frames:* - Welcome to default!=@package [ 1152781 ] PHP_NOTICE: Uninitialized string offset in ParserDescCleanup [ 1153593 ] string id="...." in tutorials [ 1156816 ] undeliverable email addresses for doc/tutorial authors [ 1164253 ] Inherited Class Constants are not displayed [ 1171583 ] CHM wrong filesource [ 1180200 ] HighlightParser does not handle Heredoc Blocks. [ 1202772 ] missing parentheses in Parser.inc line 946 [ 1203445 ] Call to a member function on a non-object in Parser.inc [ 1203451 ] array to string conversion notice in InlineTags.inc [ 1224317 ] functions refers to wrong line [ 1230004 ] Undefined index in class phpDocumentorTParser [ 1255692 ] Support for "--" argument [ 1261287 ] @filesource bug? [ 1348852 ] Call to function Convert() on a non-object + DocBlockTags [ 1366260 ] Default 0 parameter in method is not displayed [ 1373244 ] Undefined variable: root_dir in docbuilder/file_dialog.php [ 1380845 ] @uses tags not sorting [ 1391432 ] Too many underscores in include links. [ 1393998 ] HTMLSmartyConverter Fatal error (line 627) fix [ 1398977 ] @return is not merged when using DocBlock Templates [ 1428660 ] Confusing error when using {@link} in @uses [ 1456144 ] @global oddities [ 1459955 ] @todo tags are sorted descending instead of ascending [ 1462690 ] PHP Notices [ 1466205 ] more usedby than uses [ 1473272 ] Update references of phpdoc to pear-phpdoc - fixed these bugs reported in PEAR: Bug #2122: No tree menu for file identifier begining with a number Bug #2288: Webfrontend ignores more than one dir in "Files to ignore" Bug #2294: @toc tag is incompatible when XML prolog exists Bug #5011: PDF generation warning on uksort Bug #6305: array typehints break the parser Bug #6306: Tokenizer doesn't read "....<%{$key}>..." properly Bug #6389: Private classes are not used during grouping for class trees Bug #6805: Rendering bug for verbatim HTML tags Bug #6848: Reference Patch Bug #6952: Update Install docs to tell correct package.xml location Package Info ------------- 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 Related Links ------------- Package home: http://pear.php.net/package/PhpDocumentor Changelog: http://pear.php.net/package/PhpDocumentor/download/1.3.0RC6 Download: http://pear.php.net/get/PhpDocumentor-1.3.0RC6.tgz Authors ------------- Joshua Eichorn <jeichorn@JoshuaEichorn.com> (lead) Greg Beaver (lead) Andrew Morton (developer)