Latest releases

PhpDocumentor 1.4.2

2008-03-30T19:56:28-05:00

Includes these PEAR items:
Bug #12361: missing links to the filesource
Bug #12699: makedocs.sh script needs a better install location
Bug #12929: paramete 'ignore' oper mistake
Doc #12764: Update INSTALL for web docbuilder

Includes these Sourceforge items:
- [1829133] Progress display not happening until conversion finished [ashnazg]
- [1779257] ignore=.. option not working correctly on Win | fix attaced [ashnazg|mrasnika]

PhpDocumentor 1.4.1

2007-12-14T16:02:42-05:00

Includes these PEAR items:
Req #11755: Remove Unused DocBlock_Lexer and PHPT Tests [ashnazg]
Req #11757: Move PhpUnit Tests into new tests dir [ashnazg]
Bug #10909: PHP Notice in PDF Converter line 210 [ashnazg]
Bug #11613: -q flag is not honoured [ashnazg]
Bug #11683: examples displayed using earthli style are not rendered properly [ashnazg|kguest]
Bug #11788: Two failing unit tests [ashnazg]
Bug #11809: Incorrect @name usage causes fatal crash [ashnazg]
Bug #12121: phpdoc.bat cannot launch php.exe [ashnazg|kalvaro]
Bug #12172: media files are not being copied [ashnazg|nemesis]
Bug #12201: Misleading error message [ashnazg|yunosh]
Doc #12459: @subpackage does not fix name conflicts [ashnazg]

Includes these Sourceforge items:
- [1846302] php version > 4.3.0 and tokenizer [ashnazg]
- [1845584] File suffix should be lowercase [ashnazg]
- [1842595] makedoc.sh doesn't like embedded blanks in paths [ashnazg|munroe_r]
- [1839924] addErrorDie has to exit with non-zero return code! [ashnazg|blueyed]
- [1826342] Data-dependent endless(?) loop in parser [ashnazg]
- [1733936] "phpdoc" does not return with error code "0" on success [ashnazg|blueyed]

PhpDocumentor 1.4.0

2007-07-23T12:48:38-05:00

Includes these PEAR items:
Req #10670: Don't Die on Empty Tag Descriptions
Bug #10864: PhpDocumentor dies when parsing illegal page-level docblock
Bug #10870: Dead links generated with HTML:Smarty:PHP
Bug #10871: Wrong rendering of inline {@internal}}
Bug #10910: DOM templates create incorrect trees
Bug #11409: PHP Notices accompany Global Never Found errors
Doc #10675: Clear some errors.html items
Doc #10730: Replace Sourceforge Trackers with PEAR
Doc #10914: Can't use nested tags inside <kbd> or <samp>
Doc #10972: @method does not work
Doc #11032: param type1|type2 not documented
Doc #11143: Provide a Minimal Tutorial File Setup Example

Includes these Sourceforge items:
- [1733938] regression: "-" not allowed anymore in converter (file)name
- [1733936] "phpdoc" does not return with error code "0" on success
- [1733345] inline @link tag renders wrong way
- [1724990] @static tag example
- [1724884] object return parameter value
- [1722096] DocBlock template example does not work
- [1720764] documentation update needed
- [1672589] missing elements, bad links with HTML:Smarty:HandS
- [1647423] memory_limit: bad if-clause
- [1634153] require/include with concatenated file name
- [1632496] {@internal}} becomes wrong on documentation
- [1622538] List undocumented classes/functions
- [1602988] Added --ignore-symlinks option
- [1588942] Allow memory_limit setting in phpdoc.ini
- [1588936] Show INI Path at Startup
- [1585840] Refactored RETURNs #3
- [1574047] Refactored RETURNs #2
- [1574043] Refactored RETURNs #1
- [1543289] Apply ignore patterns to subdir of dir, instead of full path
- [1543287] Use predefined PHP env var in phpdoc script
- [1540666] patch for @property, @property-read and @property-write tags
- [1124133] <code> and @include....
- [1044752] List undocumented classes/functions

PhpDocumentor 1.4.0RC2

2007-07-09T22:30:29-05:00

Includes no PEAR items:

Includes these Sourceforge items:
- [1733938] regression: "-" not allowed anymore in converter (file)name
- [1733936] "phpdoc" does not return with error code "0" on success
- [1733345] inline @link tag renders wrong way
- [1722096] DocBlock template example does not work

PhpDocumentor 1.4.0RC1

2007-06-25T13:39:48-05:00

Includes these PEAR items:
Bug #11409: PHP Notices accompany Global Never Found errors

Includes these Sourceforge items:
- [1724990] @static tag example
- [1724884] object return parameter value
- [1720764] documentation update needed
- [1672589] missing elements, bad links with HTML:Smarty:HandS
- [1634153] require/include with concatenated file name
- [1632496] {@internal}} becomes wrong on documentation
- [1124133]

 and @include....



PhpDocumentor 1.4.0a2
2007-06-15T12:27:03-05:00
Includes these PEAR items:

Bug #10864: PhpDocumentor dies when parsing illegal page-level docblock

Bug #10870: Dead links generated with HTML:Smarty:PHP

Bug #10871: Wrong rendering of inline {@internal}}

Bug #10910: DOM templates create incorrect trees

Doc #10914: Can't use nested tags inside  or 

Doc #10972: @method does not work

Doc #11032: param type1|type2 not documented

Doc #11143: Provide a Minimal Tutorial File Setup Example



Includes no Sourceforge items.


PhpDocumentor 1.4.0a1
2007-04-27T12:42:42-05:00
Includes these PEAR items:

Req #10670: Don't Die on Empty Tag Descriptions

Doc #10675: Clear some errors.html items

Doc #10730: Replace Sourceforge Trackers with PEAR



Includes these Sourceforge items:

- [1647423] memory_limit: bad if-clause

- [1622538] List undocumented classes/functions

- [1602988] Added --ignore-symlinks option

- [1588942] Allow memory_limit setting in phpdoc.ini

- [1588936] Show INI Path at Startup

- [1585840] Refactored RETURNs #3

- [1574047] Refactored RETURNs #2

- [1574043] Refactored RETURNs #1

- [1543289] Apply ignore patterns to subdir of dir, instead of full path

- [1543287] Use predefined PHP env var in phpdoc script

- [1540666] patch for @property, @property-read and @property-write tags

- [1044752] List undocumented classes/functions


PhpDocumentor 1.3.2
2007-04-13T14:45:44-05:00
- fixed these bugs reported in Sourceforge:

[ 1667333 ] Mishandled Param = 0 Default in Converters

[ 1656902 ] Error when converting class that extends Exception

[ 1640392 ] docBuilder user directory

[ 1634369 ] @global syntax in @name example

[ 1633275 ] Update TODO Links to SF/PEAR Buglists

[ 1631553 ] Docs Say TODO on INCLUDE Is OK

[ 1620470 ] Ensure No Pathing Given in Output Converter Name

[ 1620396 ] INSTALL is wrong and outdated

[ 1614286 ] Fix Indexing of Constants

[ 1611861 ] Fix --hidden flag handling

[ 1611847 ] Fix PEAR Bug #9366

[ 1602961 ] "--hidden off" / "-dh off" results in hidden=true

[ 1590240 ] Double Tab-Count after Shell # Comment in SourceCode

[ 1589650 ] Segfault with PHP 5.2

[ 1588175 ] const elements sorting incorrectly

[ 1586917 ] Object of class parserLinkInlineTag could not be converted

[ 1585879 ] Fix the error text for Includes without docblock

[ 1585875 ] Error text for Includes without docblock is incorrect

[ 1583877 ] tagsort corrections in ParserDocBlock.inc

[ 1583850 ] "Created by PhpDoc", not "Somesite"

[ 1573816 ] CHM default template does not set help file title

[ 1570942 ] Grammar/Typo Corrections in Tutorial

[ 1548910 ] Do not copy \\".svn\\" and \\"CVS\\" dirs from media fol

[ 1545418 ] Duplicated title in generated tutorials (docbook)

[ 1544661 ] bteer line number alignment in smarty::php html template

[ 1543686 ] Doesn't treat interface level docblock like class level docb

[ 1525150 ] tag information displayed in random order

[ 1518565 ] "-q off" different then not passing it

[ 1348589 ] @copyright bug?

- fixed these bugs reported in PEAR:

 Bug # 9151:  ReflectionException when documenting classes derived from PHP internal classes

 Bug # 9366:  Last line with comment in <code> disappears

 Bug # 9673:  potential major security issue

 Bug # 9915:  PHP Notice in PDF Converter

 Bug # 9937:  Security Exploit CVE-2005-4593

 Bug #10266:  List in @todo tags not processed correctly

 Bug #10289:  Hangs at "Converting tutorials"


PhpDocumentor 1.3.1
2006-10-24T22:25:45-05:00
- fixed these bugs reported at sourceforge

[ 1544977 ] Command line arguments split by spaces (fix included)

[ 1545927 ] HTMLSmartyConverter logo not in package

[ 1573807 ] CHM Convertor does not strip full path for all TOC entries

[ 1575145 ] '-q on' quiet mode not fully quiet

[ 1581487 ] subdirectory include another subdirectory doc error.

- fixed these bugs reported in PEAR:

 Bug #8520: Broken XML when XML_Beautifier is installed

 Bug #8533: require() broken in a lot of places - cannot run!

 Bug #8539: Parser error in create_examples.php

 Bug #8746: XML:DocBook generates warning with function/parameters without @param tag

 Bug #8773: PDF Convertor fails due to being unable to find fonts

 Bug #8914: returning non varibale reference ParserData.inc#500

 The peardoc2 converter no longer uses funky PHP source highlighting, leaving


PhpDocumentor 1.3.0
2006-08-17T22:32:09-05:00
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 

 * 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  tag

 * un-modified output with 

 * html/xml source highlighting with 



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 since 1.3.0RC6:

 [ 941146 ] Repeated sub-tutorials

 [ 1223413 ] improper load sequence when using custom templatebase

 [ 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

 Bug #6844: phpDocumentor doesn't show classes in file

 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

- fixed these bugs since 1.2.3.1:

 [ 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 

 [ 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 ]  escapes  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