$Id$

PhpDocumentor Version 1.3.0
################################################################################
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.3.0.  This release adds in PHP 5 support, highlighting of tutorial XML,
beautifying of output from the XML:DocBook/peardoc2:default converter,
and fixes more than 100 bugs found in 1.2.3.1.  In addition, output from
source highlighting is much more efficient, resulting in slightly smaller
file size for sourcecode=on.  Also, multi-national characters are now
allowed in a package name - at your own risk.  I found that Apache 1.3
could not serve files with multi-national characters, but when loaded
directly from disk, web browsers did just fine.

------
IMPORTANT: phpDocumentor 1.3.0 requires PHP version 4.2.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.  PHP version 5.1.0 or newer is recommended to take
advantage of PHP5-only features.
------
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
------

Speaking of speed, do NOT run the PDF Converter with --sourcecode = on for any
medium to large sized projects.  I had to kill a PDF generation after 36 hours
on a Pentium IV 2.66GHz computer - 36 hours!  The design of the PDF generation
library is tremendously inefficient, probably on the order of O(n^2).  I'd fix
this if I knew anything about PDF.  If there are any users out there with the
time and expertise to look into the algorithms used by CPdf, we would all
appreciate it.

This version removes the unmaintained and not very useful dia2codeConverter

A full listing of all closed bugs and feature requests can be found in the 
next section of the notes

phpDocumentor 1.3.0 is ready for production use documenting any PHP project,
download it and try the most advanced solution for PHP documentation
today.

################################################################################

The following bugs are fixed in version 1.3.0
 [ not entered ] phpdoc script broken on unix
 [ not entered ] XMLDocBookpeardoc2 beautifier removes comments
 [ 893186 ] HTMLframes converter sometimes misses package level docs
 [ 834941 ] inline @link doesn't work within <b>
 [ 839092 ] CHM:default:default produces bad links
 [ 839466 ] {$array['Key']} in heredoc
 [ 840792 ] File Missing XML:DocBook/peardoc2:default "errors.tpl"
 [ 850731 ] No DocBlock template after page-level DocBlock?
 [ 850767 ] MHW Reference wrong
 [ 854321 ] web interface errors with template directory
 [ 856310 ] HTML:frames:DOM/earthli missing Class_logo.png image
 [ 865126 ] CHM files use hard paths
 [ 869803 ] bad md5sum
 [ 871764 ] @global doesn't work properly with whitespace after the $var
 [ 875525 ] <li> escapes <pre> and ignores paragraphs
 [ 876674 ] first line of pre and code gets left trimmed
 [ 877229 ] PHP 5 incompatibilities bork tutorial parsing
 [ 877233 ] PHP 5 incompatibilities bork docblock source highlighting
 [ 878911 ] [PHP 5 incompatibility] argv
 [ 879068 ] var arrays tripped up by comments
 [ 879151 ] HTML:frames:earthli Top row too small for IE
 [ 880070 ] PHP5 visability for member variables not working
 [ 880488 ] '0' file stops processing
 [ 884863 ] Multiple authors get added in wrong order.
 [ 884869 ] Wrong highligthing of object type variables
 [ 892305 ] peardoc2: summary require_once Path/File.php is PathFile.php
 [ 892306 ] peardoc2: @see of method not working
 [ 892479 ] {@link} in // comment is escaped
 [ 893470 ] __clone called directly in PackagePageElements.inc
 [ 895656 ] initialized private variables not recognized as private
 [ 896444 ] Bad line numbers
 [ 904823 ] IntermediateParser fatal error
 [ 907734 ] Exception Class is builtin to PHP5
 [ 910676 ] Fatal error: Smarty error: unable to write to $compile_dir
 [ 915770 ] Classes in file not showing
 [ 924313 ] Objec access on array
 [ 924760 ] source rendering in FireFox contains extra newlines
 [ 937235 ] duplicated /** after abstract method declaration
 [ 941146 ] Repeated sub-tutorials
 [ 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
 [ 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
 [ 1223413 ] improper load sequence when using custom templatebase
 [ 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
 [ 1481118 ] Tags with more than one attribute keep only the first one.
 [ 1485448 ] Mixing {@toc} and DOCTYPE for DocBook gives PHP fatal error
 [ 1486304 ] unexpected parameter type mixed
 [ 1490000 ] Javascript in header.tpl cause httpd log: File not found
 [ 1491119 ] Inexistant --directory leads to obscure error message
 [ 1492100 ] Warning: fread(): Length parameter must be greater than 0
 [ 1492101 ] Object of class parserLinkInlineTag could not be converted
 [ 1492538 ] ERROR: Converter X specified by ... is not a class
 [ 1492608 ] PHP Notices in current CVS
 [ 1497452 ] Fatal error: Call to undefined method parserFunction::setMo
 [ 1503927 ] Wrong '--' suffix on some files
 [ 1512969 ] Call to a member function cantSource() on a non-object
 [ 1516781 ] Use of undefined constant T_ML_COMMENT - assumed 'T_ML_COMME
 [ 1524102 ] Weird include documentation
 [ 1528752 ] Trivial typo in "phpDocumentor Inline tags" documentation
 [ 1533361 ] trailing comments stop phpdoc on source generation
 [ 1532841 ] '%' in function parameter default value causes errors
 [ 1540233 ] memory exshausted
- 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 #6844: phpDocumentor doesn't show classes in file
 Bug #6848: Reference Patch
 Bug #6952: Update Install docs to tell correct package.xml location
 Bug #7554: Call to undefined method ReflectionClass::hasMethod()
 Bug #7577: Notice error for undefined _pv_function_param property
 Bug #7686: phpdoc not run in dos box
 Bug #7773: "nothing parsed" error when parsing in a directory under "tutorials"
 Bug #7938: @todo does not work on include elements
 Bug #8111: Fatal error: ReflectionClass::hasProperty()
 Bug #8290: @param bug when description is on its own line

There of course were other small bugs fixed, these were just the bugs with 
entries in source forge.  You can view the bug details or reopen it if
you think it's not totally fixed at:
http://sourceforge.net/tracker/?group_id=11194&atid=111194

Features added that had Feature Request entries in SF for 1.3.0:
 [ 727084 ] Support for custom files to include (README etc).
 [ 749279 ] inline {@example} tag
 [ 799026 ] Images in tutorials
 [ 799232 ] Change behavior of -c key to use any configuration file.
 [ 856770 ] PHP 5 support

################################################################################

The documentation has been updated for this release you can view it at
http://www.phpdoc.org/docs
or in the distribution in the spec directory

The changelog is available in the tarball, or online at 
http://phpdocu.sourceforge.net/Changelog

You can download the newest version from 
http://phpdocu.sourceforge.net/downloads.php

And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
http://phpdoc.org/ 

enjoy
-joshua eichorn <jeichorn@phpdoc.org>
-gregory beaver <cellog@php.net>


vim: set expandtab :
