1$Id: Release-1.4.0rc1 239305 2007-07-08 23:06:36Z ashnazg $
2
3PhpDocumentor Version 1.4.0
4################################################################################
5http://www.phpdoc.org
6Gregory Beaver cellog@php.net
7Joshua Eichorn jeichorn@phpdoc.org
8################################################################################
9################################################################################
10
11The phpDocumentor team would like to announce the release of phpDocumentor
121.4.0.  This feature release adds initial support for documenting "magic"
13properties, a couple of new runtime options, plus a few minor internal
14enhancements.
15
16------
17IMPORTANT:  phpDocumentor 1.4.0 requires PHP version 4.2.0 or greater.
18phpDocumentor will function best with PHP version 4.3.0 or greater, as it will
19use of the tokenizer extension if php 4.3.0 is installed for a tremendous
20increase in parsing speed.  PHP version 5.1.0 or newer is recommended to take
21advantage of PHP5-only features.
22
23WARNING:  A bug in PHP v5.2.1 can cause PhpDocumentor v1.3.1 and older to
24spiral into an infinite loop when parsing tutorial documents.  PhpDocumentor
25v1.3.2 and newer will crash itself at the beginning of the tutorial parsing
26stage if it detects PHP v5.2.1 being used to parse tutorials.
27------
28
29Speaking of speed, do NOT run the PDF Converter with --sourcecode = on for any
30medium to large sized projects.  I had to kill a PDF generation after 36 hours
31on a Pentium IV 2.66GHz computer - 36 hours!  The design of the PDF generation
32library is tremendously inefficient, probably on the order of O(n^2).  I'd fix
33this if I knew anything about PDF.  If there are any users out there with the
34time and expertise to look into the algorithms used by CPdf, we would all
35appreciate it.
36
37A full listing of all closed bugs and feature requests can be found in the
38next section of the notes.
39
40phpDocumentor 1.4.0 is ready for production use documenting any PHP project,
41download it and try the most advanced solution for PHP documentation
42today.
43
44################################################################################
45
46The following PEAR items are included in version 1.4.0:
47Bug #11409: PHP Notices accompany Global Never Found errors
48Req #10670: Don\'t Die on Empty Tag Descriptions
49Doc #10675: Clear some errors.html items
50Doc #10730: Replace Sourceforge Trackers with PEAR
51Bug #10864: PhpDocumentor dies when parsing illegal page-level docblock
52Bug #10870: Dead links generated with HTML:Smarty:PHP
53Bug #10871: Wrong rendering of inline {@internal}}
54Bug #10910: DOM templates create incorrect trees
55Doc #10914: Can't use nested tags inside <kbd> or <samp>
56Doc #10972: @method does not work
57Doc #11032: param type1|type2 not documented
58Doc #11143: Provide a Minimal Tutorial File Setup Example
59
60
61The following Sourceforge items are included in version 1.4.0:
62- [1724990] @static tag example
63- [1724884] object return parameter value
64- [1720764] documentation update needed
65- [1672589] missing elements, bad links with HTML:Smarty:HandS
66- [1647423] memory_limit: bad if-clause
67- [1634153] require/include with concatenated file name
68- [1632496] {@internal}} becomes wrong on documentation
69- [1622538] List undocumented classes/functions (thanks Sebastian Marconi)
70- [1602988] Added --ignore-symlinks option (thanks Daniel Hahler)
71- [1588942] Allow memory_limit setting in phpdoc.ini
72- [1588936] Show INI Path at Startup
73- [1585840] Refactored RETURNs #3
74- [1574047] Refactored RETURNs #2
75- [1574043] Refactored RETURNs #1
76- [1543289] Apply ignore patterns to subdir of dir, instead of full path (thanks Daniel Hahler)
77- [1543287] Use predefined PHP env var in phpdoc script (thanks Daniel Hahler)
78- [1540666] patch for @property, @property-read and @property-write tags (thanks Derick Rethans)
79- [1124133] <code> and @include....
80- [1044752] List undocumented classes/functions
81
82
83You can view the bug details or reopen one if
84you think it's not totally fixed at:
85http://pear.php.net/bugs/search.php?cmd=display&package_name%5B%5D=PhpDocumentor
86http://sourceforge.net/tracker/?group_id=11194&atid=111194
87
88################################################################################
89
90The documentation has been updated for this release you can view it at
91http://www.phpdoc.org/docs
92or in the distribution in the spec directory
93
94The changelog is available in the tarball, or online at
95http://pear.php.net/package/PhpDocumentor/download/
96
97You can download the newest version from
98http://pear.php.net/package/PhpDocumentor/download/
99and http://phpdocu.sourceforge.net/downloads.php
100
101And of course you can reach the webpage at
102http://pear.php.net/package/PhpDocumentor/ or
103http://phpdocu.sourceforge.net/ or
104http://phpdoc.org/
105
106enjoy
107-gregory beaver <cellog@php.net>
108-joshua eichorn <jeichorn@phpdoc.org>
109
110
111vim: set expandtab :
112