News Articles
phpDocumentor 1.4.2 released
The phpDocumentor team would like to announce the release of phpDocumentor 1.4.2.
This release fixes two Windows-specific bugs, one involving usage of the "--ignore" option, and one involving usage of the @filesource tag.
Other minor changes are moving the install location of the "makedocs.sh" utility script (so that it doesn't end up in "/usr/bin" on *nix) and small documentation updates.
The following PEAR items are included in version 1.4.2:
- 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
The following Sourceforge items are included in version 1.4.2:
- [1829133] Progress display not happening until conversion finished [ashnazg]
- [1779257] ignore=.. option not working correctly on Win | fix attaced [ashnazg|mrasnika]
Posted by: Joshua Eichorn on 2008-03-31
phpDocumentor 1.4.0 Released
The PhpDocumentor team would like to announce the release of PhpDocumentor version 1.4.0 through SourceForge and pear.php.net. This is the first stable feature release since 2006.
This release adds in:
- new tags for "magic" properties and methods
- new runtime options "--ignoresymlinks" and "--undocumentedelements"
-
new memory_limit option in phpDocumentor.ini
- allows you to configure PHP's memory_limit setting for the PhpDocumentor execution only, rather than modifying it in your php.ini file
This release also fixes several bugs from 1.3.2.
You can upgrade using pear upgrade or downloading the code from SourceForge http://sourceforge.net/project/showfiles.php?group_id=11194
Changelog:
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
Posted by: Joshua Eichorn on 2007-07-23
Phpdocumentor 1.4.0a1 Released
Phpdocumentor 1.4.0a1 is a alpha release containing a number of feature additions. The most notable addition is support for @property, @property-read and @property-write tags. These allow you to document properties made available through __get and __set. The manual includes details on how to use the new tags.
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
Posted by: Joshua Eichorn on 2007-04-27
phpDocumentor 1.3.2 released
RELEASE ANNOUNCEMENT
phpDocumentor version 1.3.2 has been released through SourceForge and through pear.php.net.
This release is considered stable and is recommended for production usage.
Version 1.3.2 is a bug fix release and is a recommended upgrade for all users.
You can upgrade using pear upgrade or downloading the code from SourceForge
http://sourceforge.net/project/showfiles.php?group_id=11194
Here is the full changelog:
- 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"
Posted by: Joshua Eichorn on 2007-04-13
PhpDocumentor 1.3.0 stable is released
PhpDocumentor 1.3.0 stable
August 18, 2006
Download:
pear upgrade PhpDocumentor
http://pear.php.net/PhpDocumentor
http://sourceforge.net/project/showfiles.php?group_id=11194&package_id=10450&release_id=440432
Information and documentation:
http://www.phpdoc.org
The PhpDocumentor team would like to announce the release of PhpDocumentor version 1.3.0. This is the first stable release since 2003, and marks a dramatic step up from previous releases.
This release adds in:
- full PHP 5 support, including knowledge of internal classes for PHP version 5.1.0+ using the Reflection extension.
- highlighting of tutorial XML
- beautifying of output from the XML:DocBook/peardoc2:default converter
In addition, the release fixes more than 100 bugs found since version 1.2.3. Output from source highlighting is much more efficient, resulting in slightly smaller file size for option sourcecode=on. Multi-national characters are now allowed in a package name, although internationalization support is not fully complete.
PhpDocumentor is the standard automatic documentation solution for PHP written in PHP. Originally inspired by JavaDoc, PhpDocumentor has over 6 years of battle-testing and is bundled in popular IDEs such as Zend Studio, PHPEdit, PhpEd, and others.
Posted by: Joshua Eichorn on 2006-08-18
PhpDocumentor-1.3.0RC6 Released
PHP 5 support and more.
The vast majority of the bugs in both the Sourceforge tracker and on in the PEAR bug database have been fixed in this release. We hope to follow it up shortly with a 1.3.0 final.
This release fixes a large number of bugs, and switches
to the LGPL license instead of the PHP License.
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&rt;
- 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">
Posted by: Joshua Eichorn on 2006-05-2
Projects list moved to a wiki
In an effort to help get more people involved in phpDocumentor i've set up a section for it in my wiki.
Right now its only being used for maintaining the projects using phpDocumentor list, since I never updated the hard coded version.
If your using phpDocumentor please add your project to the list.
Posted by: Joshua Eichorn on 2006-02-25
Rss Feed added
An rss feed has been added for phpDocumentor news. I just hacked it up so hopefully it works right. Let me know if you see any problems, the feed should be added to planet.php.net once its been tested a bit.
Posted by: Joshua Eichorn on 2005-12-27
phpDocumentor 1.3.0 RC4 is Released
PHP 5 support and more, fix bugs
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. 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
Bugs Fixed
- 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 ] XMLDocBookpeardoc2 beautifier removes comments
[ 896444 ] Bad line numbers
[ 937235 ] duplicated /** after abstract method declaration
[ 962319 ] Define : don't show the assigned value
[ 977674 ] Parser error
[ 989258 ] wrong interfaces parsing
[ 1150809 ] Infinite loop when class extends itself
[ 1151196 ] PHP Fatal error: Cannot re-assign $this
[ 1151650 ] UTF8 decoding for DocBook packages
[ 1152781 ] PHP_NOTICE: Uninitialized string offset in ParserDescCleanup
[ 1153593 ] string id="...." in tutorials
[ 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
- fixed these bugs reported in PEAR:
Bug #2288: Webfrontend ignores more than one dir in "Files to ignore"
Bug #5011: PDF generation warning on uksort
Available from PEAR or from Sourceforge
Website: http://phpdoc.org
Pear Links:
Package home: http://pear.php.net/package/PhpDocumentor
Changelog: http://pear.php.net/package/PhpDocumentor/download/1.3.0RC4
Download: http://pear.php.net/get/PhpDocumentor-1.3.0RC4.tgz
SF Links:
Project Page: http://sourceforge.net/projects/phpdocu/
Download: http://sourceforge.net/project/showfiles.php?group_id=11194&package_id=10450&release_id=374570
Release Notes: http://sourceforge.net/project/shownotes.php?release_id=374570&group_id=11194 Posted by: Joshua Eichorn on 2005-11-29
phpDocumentor Support for Vim
PDV - phpDocumentor for Vim : Provides really comfortable generation of phpDocumentor doc blocks for PHP4 & 5
For more info read Tobias
blog posting announcing it.
Posted by: Joshua Eichorn on 2005-09-16