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