$Id: Release-1.2.0rc1 234145 2007-04-19 20:20:57Z ashnazg $ PhpDocumentor Version 1.2.0 RELEASE CANDIDATE 1 ################################################################################ http://www.phpdoc.org Joshua Eichorn jeichorn@phpdoc.org Gregory Beaver cellog@php.net ################################################################################ ################################################################################ The phpDocumentor team would like to announce the release of phpDocumentor 1.2.0 RELEASE CANDIDATE 1. All features that will be present in the final release of 1.2.0 have been implemented, and all known bugs fixed. This release is only intended to ensure that all bugs have been fixed before the big release. The structure of the {@source} tag has changed slightly in this release. See the documentation of inline {@source} for details for PEAR users, the new --pear command-line switch will be a boon. Leave it on by default if your package follows PEAR coding and directory naming standards The peardoc2 converter has been moved to an extension of the DocBook converter, to use, the command-line has changed from XML:DocBook:peardoc2 to XML:DocBook/peardoc2:default. ------ IMPORTANT: phpDocumentor 1.2.0rc1 requires PHP version 4.1.0 or greater. phpDocumentor will function best with PHP version 4.3.0 or greater, as it will use of the tokenizer extension if php 4.3.0 is installed for a tremendous increase in parsing speed. ------ phpDocumentor is a JavaDoc-like automatic documentation generator for PHP written in PHP. It is the most versatile tool for documenting PHP. Once again, phpDocumentor brings a great increase in usability with the 1.2 branch. The addition of a tokenizer-based parser increases parsing speed by up to 4 times (that's 400% faster) compared to previous versions. In addition, scalability has been improved, allowing generation of documents in multiple output formats with one command. The usage of config files makes repetitive parsing tasks straightforward and reduces the chance for error. The addition of DocBlock templates, extended documentation (tutorials) parsing, and many other new features make this release the most useful automatic documentor for any programming language. The default HTML Converter has been ported to a new Smarty-based converter, HTMLframesConverter, and all of the old templates have been ported to the new Smarty-based format. The HTMLdefaultConverter has been deprecated since its functionality is redundant. Due to the time it takes to convert a template to the new format, the phpDocumentor team extends an offer to do this conversion for anyone who has a brand new template. We may also include the template in a future release, if permission is granted. Due to interest from PEAR programmers, there is a new beta-quality XML:DocBook converter with peardoc2 templates. This converter could also generate other DocBook formats, if desired, but does not generate indexing for this release. The PDF Converter has stepped up to beta-quality, is fully templatable, and has most bugs completely fixed. The CHM converter has also taken major strides and is close to beta quality. As predicted, the Smarty template engine is the primary template engine for all converters. For users new to phpDocumentor, phpDocumentor uses an event-driven parser and intermediary data structures that allow it to perform at a level other automatic documentors for PHP cannot achieve: --parsing any php file, with multiple classes and functions in the same file --fully compliant with even the most esoteric php syntax ($string = <<< EOF, for example) --ability to generate multiple output formats --extremely fast parsing --error/warnings by line number and file to allow for debugging of documentation tags --multiple output templates to easily customize the look of generated documentation --extensive documentation of the package, including a detailed specification for tags and the included template engine --open source, GPL A full listing of all closed bugs and feature requests can be found in the next section of the notes phpDocumentor 1.2.0rc1 is nearly ready for production use documenting any PHP project, download it and try the most advanced solution for PHP documentation today to help us find the last hidden bugs. ################################################################################ The following bugs are fixed in version 1.2.0RC1 [ 566663 ] @param &$arg broken [ 657041 ] {@source} doesn't work right [ 675871 ] --pear breaks if not a pear repository [ 678176 ] Inherited vars/methods in HTML:frames:phpedit [ 680652 ] Optional method/function parameters [ 681459 ] {@internal}} not quite working [ 681463 ] {@source} drops characters [ 681735 ] {@source} in sdesc needs warning [ 682490 ] {@internal}} not parsed right by highlightparser [ 682491 ] multi-line description fubared in @tag [ 687091 ] special characters not encoded [ 687364 ] highlightparser $class->member incorrect [ 687403 ] {@source} leaves "}" [ 689874 ] is_a is not avaliable in PHP 4.1.0 [ 689893 ] Warnings on PHP 4.1.0 [ 689894 ] getincludevalue() missing argument 2 warning [ 692522 ] @uses is screwy [ 693213 ] tutorials post-processed twice [ 693215 ] {@internal}} on single line not working [ 694448 ] PKZip has bug, use winzip (not phpDocumentor bug) [ 694594 ] PEAR mode: destructor image not shown by phpedit template [ 694742 ] PDF converter has no table of contents [ 695291 ] link to todo disappears in HTML:Smarty:* [ 695482 ] @uses not checking for @access private [ 695622 ] HTML:Smarty:* has no package-level docs [ 696883 ] in description crashes parser [ 697156 ] PHP Warning with PDF Converter [ 697656 ] putting a inside a
  • turns it into a literal [ 698417 ] {@link element descrip} wrong [ 697644 ] parse fails if unmatched html tag, or text outside
  • list [ 698468 ] Fatal error when inline tag across two lines [ 698356 ] {@internal} not working properly [ 701199 ] extra br in @filesource generation [ 702549 ] --quiet option not valid? [ 705897 ] HTML:frames:earthli misses Page.gif [ 708560 ] intelligent list handling isn't quite working [ 708559 ] @category tag not really working [ 710366 ] -Tag is ignored [ 710700 ] empty defaultpackagename = caused busy loop [ 711569 ] Fatal Error: Undefined Method during write [ 712704 ] HTML:Smarty:* drops class level author information [ 708914 ] , , broken [ 713201 ] variable variables are not parsed properly in @global [ 713954 ] @param type $var when &$var broken [ 715077 ] HighlightParser needs @tag object classname support [ 715084 ] HighlightParser craps out after $var-> [ 715452 ] @example doesn't work with anything other than .php [ 718253 ] Using 'parent' in @example file causes crash The following bugs are fixed in version 1.2.0BETA3 [ 661317 ] PDF converter in subpackage ids broken [ 669945 ] CHM: "undefined function: convert()" with multiple outputs [ 670205 ] inherited methods have no links [ 670341 ] 
     in docblock doesn't htmlentitie
 [ 670350 ] left_frame.tpl missing package level doc link
 [ 670440 ] Io::getBase() is buggy
 [ 670903 ] inline desc  not 
    -ized
 [ 671620 ] warning in Parser line 2271
 [ 672149 ] @desc broken
 [ 674053 ] Support for require_once 
 [ 674059 ] requires PHP version 4.2 or higher
 [ 674075 ] Bad @param kills parser
 [ 677105 ] unbalanced HTML-comments in output of HTML:frames:phpedit
 [ 677821 ] define not parsed right in highlightparser
 [ 677822 ] {@source} not showing whole source
 [ 677826 ] nonsense @link in @see breaks HTML output
 [ 677938 ] whitespace wrong after certain docblocks

The following bugs are fixed in version 1.2.0BETA2
 [ 665707 ] Warnings and errors in new_phpdoc.php
 [ 666307 ] whitespace not ignored in @param
 [ 669132 ] "no @package tag was used" error but @ignore & @package used
 [ 669525 ] {$children[kids].sdesc} contains parent sdesc
 [ 669613 ] Call to undefined function: getclassleft()
 [ 669615 ] methods disapper
 [ 669640 ] javadocdesc broken
 [ 669909 ] PDF text starts off left side of page when have package.html

The following bugs are fixed in version 1.2.0BETA1a
 [ 661976 ] @see broken
 [ 662630 ] {} delimited variables within strings mess up the parser
 [ 663435 ] define values, global variable values need htmlentities
 [ 664058 ] @param not displayed in HTMLframesConverter 

The following bugs are fixed in version 1.2.0BETA1

 [ 586357 ] ignore a directory
 [ 637921 ] sorting is weird with multiple package
 [ 637928 ] multiple converters legal, but fails
 [ 638042 ] two declarations of checkstate()
 [ 638128 ] commandline win32 fails, w/relative path
 [ 639553 ] new_phpdoc.php fails with php 4.2.3
 [ 640507 ] constructor links broken
 [ 641076 ] second instance of loop fails
 [ 641235 ] need trim of -f and -d commandline
 [ 641334 ] parse