d5189adc2cb77deecea2bb5044050d1cb3f7d51a
[atutor.git] / mods / phpdoc2 / PhpDocumentor / Release-1.4.1
1 $Id: Release-1.4.1,v 1.2 2007/12/14 18:33:13 ashnazg Exp $\r
2 \r
3 PhpDocumentor Version 1.4.1\r
4 ################################################################################\r
5 http://www.phpdoc.org\r
6 Gregory Beaver cellog@php.net\r
7 Joshua Eichorn jeichorn@phpdoc.org\r
8 ################################################################################\r
9 ################################################################################\r
10 \r
11 The phpDocumentor team would like to announce the release of phpDocumentor\r
12 1.4.1.  This release deprecates the usage of the old "phpdoc.php" and \r
13 "new_phpdoc.php" webpage interfaces, in favor of the docbuilder interface...\r
14 the files remain in the application, but for now they automatically redirect\r
15 to the docbuilder interface.  This release also fixes some runtime execution \r
16 bugs, provides a few  clarification updates to the manual, and establishes \r
17 unit tests available to the "pear run-tests" command.\r
18 \r
19 ------\r
20 IMPORTANT:  phpDocumentor 1.4.1 requires PHP version 4.2.0 or greater.\r
21 phpDocumentor will function best with PHP version 4.3.0 or greater, as it will\r
22 use of the tokenizer extension if php 4.3.0 is installed for a tremendous\r
23 increase in parsing speed.  PHP version 5.1.0 or newer is recommended to take\r
24 advantage of PHP5-only features.\r
25 \r
26 WARNING:  A bug in PHP v5.2.1 can cause PhpDocumentor v1.3.1 and older to\r
27 spiral into an infinite loop when parsing tutorial documents.  PhpDocumentor \r
28 v1.3.2 and newer will crash itself at the beginning of the tutorial parsing \r
29 stage if it detects PHP v5.2.1 being used to parse tutorials.\r
30 ------\r
31 \r
32 Speaking of speed, do NOT run the PDF Converter with --sourcecode = on for any\r
33 medium to large sized projects.  I had to kill a PDF generation after 36 hours\r
34 on a Pentium IV 2.66GHz computer - 36 hours!  The design of the PDF generation\r
35 library is tremendously inefficient, probably on the order of O(n^2).  I'd fix\r
36 this if I knew anything about PDF.  If there are any users out there with the\r
37 time and expertise to look into the algorithms used by CPdf, we would all\r
38 appreciate it.\r
39 \r
40 A full listing of all closed bugs and feature requests can be found in the \r
41 next section of the notes.\r
42 \r
43 phpDocumentor 1.4.1 is ready for production use documenting any PHP project,\r
44 download it and try the most advanced solution for PHP documentation\r
45 today.\r
46 \r
47 ################################################################################\r
48 \r
49 The following PEAR items are included in version 1.4.1:\r
50 Req #11755: Remove Unused DocBlock_Lexer and PHPT Tests [ashnazg]\r
51 Req #11757: Move PhpUnit Tests into new tests dir [ashnazg]\r
52 Bug #10909: PHP Notice in PDF Converter line 210 [ashnazg]\r
53 Bug #11613: -q flag is not honoured [ashnazg]\r
54 Bug #11683: examples displayed using earthli style are not rendered properly\r
55             [ashnazg|kguest]\r
56 Bug #11788: Two failing unit tests [ashnazg]\r
57 Bug #11809: Incorrect @name usage causes fatal crash [ashnazg]\r
58 Bug #12121: phpdoc.bat cannot launch php.exe [ashnazg|kalvaro]\r
59 Bug #12172: media files are not being copied [ashnazg|nemesis]\r
60 Bug #12201: Misleading error message [ashnazg|yunosh]\r
61 Doc #12459: @subpackage does not fix name conflicts [ashnazg]\r
62 \r
63 The following Sourceforge items are included in version 1.4.1:\r
64 - [1846302] php version > 4.3.0 and tokenizer [ashnazg]\r
65 - [1845584] File suffix should be lowercase [ashnazg]\r
66 - [1842595] makedoc.sh doesn\'t like embedded blanks in paths [ashnazg|munroe_r]\r
67 - [1839924] addErrorDie has to exit with non-zero return code! [ashnazg|blueyed]\r
68 - [1826342] Data-dependent endless(?) loop in parser [ashnazg]\r
69 - [1733936] "phpdoc" does not return with error code "0" on success\r
70             [ashnazg|blueyed]\r
71 \r
72 \r
73 You can view the bug details or reopen one if\r
74 you think it's not totally fixed at:\r
75 http://pear.php.net/bugs/search.php?cmd=display&package_name%5B%5D=PhpDocumentor\r
76 http://sourceforge.net/tracker/?group_id=11194&atid=111194\r
77 \r
78 ################################################################################\r
79 \r
80 The documentation has been updated for this release you can view it at\r
81 http://www.phpdoc.org/docs\r
82 or in the distribution in the spec directory\r
83 \r
84 The changelog is available in the tarball, or online at \r
85 http://pear.php.net/package/PhpDocumentor/download/\r
86 \r
87 You can download the newest version from \r
88 http://pear.php.net/package/PhpDocumentor/download/ \r
89 and http://phpdocu.sourceforge.net/downloads.php\r
90 \r
91 And of course you can reach the webpage at\r
92 http://pear.php.net/package/PhpDocumentor/ or\r
93 http://phpdocu.sourceforge.net/ or\r
94 http://phpdoc.org/\r
95 \r
96 enjoy\r
97 -gregory beaver <cellog@php.net>\r
98 -joshua eichorn <jeichorn@phpdoc.org>\r
99 \r
100 \r
101 vim: set expandtab :\r