home *** CD-ROM | disk | FTP | other *** search
/ Enter 2004 June / ENTER.ISO / files / xampp-win32-1.4.5-installer.exe / xampp / Release-1.0.0 < prev    next >
Encoding:
Text File  |  2004-03-24  |  9.5 KB  |  217 lines
  1. PhpDocumentor Version 1.0.0    STABLE
  2. ################################################################################
  3. http://www.phpdoc.org
  4. Joshua Eichorn jeichorn@phpdoc.org
  5. Gregory Beaver cellog@users.sourceforge.net
  6. ################################################################################
  7. ################################################################################
  8.  
  9. The PHPDocumentor team would like to announce the release of PHPDocumentor
  10. 1.0.0 STABLE.  This is a stable release with all features implemented and 
  11. known bugs fixed.  Getting to a stable release has been a long process and
  12. the team would like to thank everyone who has helped along the way.  Without
  13. bug submissions, feature requests, and encouragement, we wouldn't be here.
  14.  
  15. The past month has been very productive for the project, in the week since
  16. 1.0.0rc1 we have closed 40 bugs, and in the month leading to the 1.0.0rc1 release we
  17. closed 68 bugs and added a number of new features.  This hard work had turned
  18. phpDocumentor in a stable project that should be able to document anything
  19. you throw at it.
  20.  
  21. PHPDocumentor is a JavaDoc-like automatic documentation generator for PHP
  22. written in PHP.  It is the most versatile tool for documenting PHP.
  23.  
  24. For users new to PHPDocumentor, PHPDocumentor uses an event-driven parser
  25. and intermediary data structures that allow it to perform at a level other
  26. automatic documentors for PHP cannot achieve:
  27.   --parsing any php file, with multiple classes and functions in the same file
  28.   --fully compliant with even the most esoteric php syntax 
  29.       ($string = <<< EOF, for example)
  30.   --ability to generate multiple output formats
  31.   --extremely fast parsing
  32.   --error/warnings by line number and file to allow for debugging of
  33.     documentation tags
  34.   --multiple output templates to easily customize the look of generated
  35.     documentation
  36.   --extensive documentation of the package, including a detailed specification
  37.     for tags and the included template engine
  38.   --open source, GPL
  39.  
  40. Changes from the release candidate include:
  41.   --fixes to bugs with parsing extremely large projects
  42.   --linking to defines fixed
  43.   --new templates for dom supporting browsers that allows for 
  44.       minimizing/maximizing classes in the left list
  45.   --brand new template spec in the spec/templates directory
  46.   --better error handling, new unknown tags array in parserDocBlock for
  47.     Converter use in custom templates
  48.   
  49. Changes from version 0.4.2a include:
  50.   --resolution of many bugs
  51.   --the addition of intermediary parsing structures that nearly double parsing speed
  52.     and allow for new Converter class to process output
  53.   --improved class inheritance and package handling
  54.   --error and warning system
  55.   --improved inline documentation and external documentation
  56.  
  57. A full listing of all closed bugs and feature requests can be found in the 
  58. next section of the notes
  59.  
  60. PHPDocumentor is ready for immediate use documenting any PHP project,
  61. download it and try the most advanced solution for PHP documentation today
  62.  
  63. ################################################################################
  64.  
  65. The following bugs are fixed in version 1.0.0
  66.     [ 560202 ] docblock_desc not formatted correctly
  67.     [ 560377 ] package-level docs parsed, not shown
  68.     [ 560021 ] memory_limit
  69.     [ 560374 ] crash while parsing large projects
  70.     [ 560191 ] See also links to define()'s not working
  71.     [ 558046 ] clean Up handleDockeyword
  72.     [ 559825 ] same class, diff package links break
  73.     [ 559492 ] duplicate classes in same package needs warning
  74.     [ 559467 ] @see problem with constants
  75.     [ 559483 ] @see problem with constants pt2
  76.     [ 559490 ] left.html lists unsorted
  77.     [ 559489 ] DB package written to wrong package - dupe of 559492
  78.     [ 559488 ] class trees have too many classes
  79.     [ 559776 ] proc page disappears, warning in Render
  80.     [ 559495 ] child class, same file, diff package breaks classtrees
  81.     [ 559668 ] require_once parse error
  82.     [ 559494 ] var with "array" in name parsed wrong
  83.     [ 559464 ] add $dir property to DataDocBlock class
  84.     [ 559003 ] inheritance weird with diff packages
  85.     [ 559211 ] template images hardcoded in renderer
  86.     [ 559201 ] l33t theme messed up
  87.     [ 559204 ] blank.html still hardcoded
  88.     [ 558873 ] parsing with default = main package erro
  89.     [ 558823 ] ignore with full path broken
  90.     [ 558807 ] Multiple files with -f can't be separate
  91.     [ 558732 ] -f with wild cards processes 1 file only
  92.     [ 558758 ] packageoutput broken
  93.     [ 557861 ] sometimes procedural files aren't listed
  94.     [ 558497 ] Warning + Fatal errors in phpdoc-1.0.0rc
  95.     [ 558093 ] Nothing shows up with missing parent
  96.     [ 558051 ] tag errors should create warnings
  97.     [ 558077 ] Death in Converter stage parsing PEAR
  98.     [ 558080 ] More Death parsing PEAR
  99.     [ 558071 ] Error Processing Root Trees
  100.     [ 558028 ] Illegal packagename in pear
  101.     [ 558082 ] Warning at end of Parsing cvs PEAR
  102.     [ 558084 ] Lots of classes can't find parent PEAR
  103.     
  104. The following bugs are fixed in version 1.0.0rc1:
  105.     [ 558056 ] Package name check to strict
  106.     [ 558031 ] Multiple @access tags causes error in IntermediateParser.inc
  107.     [ 557767 ] some indexing has wrong filename
  108.     [ 557557 ] another copy of the howto isn't helpful
  109.     [ 557060 ] document commandline switches
  110.     [ 557691 ] crash on ParserData.inc line 1501
  111.     [ 557663 ] class links on procpage unstable
  112.     [ 557669 ] phpdoc.php needs parseprivate
  113.     [ 557665 ] @var should be like @return, not @package
  114.     [ 557585 ] class trees blank if 1 class
  115.     [ 557164 ] bad copying of images n css files
  116.     [ 557570 ] no quote events called from PARSER_EVENT_DEFINE_PARAMS 
  117.     [ 557568 ] page links broken
  118.     [ 557558 ] only have 1 copy of the howto
  119.     [ 55754a ] 2bg_left.png in l0l33t isn't valid png
  120.     [ 557390 ] asterisks in docblock not parsed
  121.     [ 557384 ] same fix for @package needed for @var
  122.     [ 557164 ] bad copying of images n css files
  123.     [ 557523 ] update converter docs
  124.     [ 557468 ] parserClass::getChildList() broken
  125.     [ 557466 ] class tree not always working
  126.     [ 556991 ] Directory names and module names
  127.     [ 553746 ] Template directory not getting set
  128.     [ 556894 ] Methods not Inheirited when subpackage different
  129.     [ 556984 ] @see anchor tags and htmlentities
  130.     [ 556860 ] strange, */ is parsed function name
  131.     [ 556625 ] document new Classes.inc
  132.     [ 556863 ] $element->fileAlias undefined line 760
  133.     [ 556838 ] Parser.inc warning
  134.     [ 556768 ] procedural page links to wrong thing
  135.     [ 550571 ] php Warnings undefined index
  136.     [ 556451 ] Element summary duplicate/missing links
  137.     [ 556222 ] warning on line 752 NewRender
  138.     [ 556031 ] inherited indexing of methods broken
  139.     [ 556034 ] order of parsing important
  140.     [ 553607 ] linking across packages works
  141.     [ 555805 ] index proc. pages by file not name
  142.     [ 555803 ] blank index entries
  143.     [ 555800 ] empty procedural pages in index
  144.     [ 554712 ] & references parsed incorrectly
  145.     [ 554422 ] HOWTO 0.4 isn't formatted properly
  146.     [ 553615 ] @abstract always says function
  147.     [ 553559 ] multiple elements in index
  148.     [ 553609 ] class package inheritance slightly broke
  149.     [ 555768 ] if inline tag improperly closed, fails
  150.     [ 553614 ] parsing broken on parserBase
  151.     [ 555759 ] multiple var declarations screwy
  152.     [ 550489 ] comments with # not handled
  153.     [ 552615 ] document new stuff
  154.     [ 541886 ] ignore path and directory do not work
  155.     [ 553073 ] make package-level parsing pre-render
  156.     [ 551120 ] parens in include not handled
  157.     [ 553135 ] array missing from array('1', '2', '3' =
  158.     [ 553560 ] error in long strings with {@link}
  159.     [ 553393 ] generatepkgelementindex broken
  160.     [ 553158 ] problem with package indexing
  161.     [ 553138 ] links to $varname in class broken
  162.     [ 553137 ] Linker comma-delimited @see broken
  163.     [ 552611 ] fix inheritance overriding
  164.     [ 553043 ] Constructor Should be Documented Seperat
  165.     [ 552620 ] some classes not parsed
  166.     [ 552612 ] fix crash on parserDocBlock added to pac
  167.     [ 552976 ] package-level assigned to wrong package
  168.     [ 552621 ] getLink in ParserData.inc broken
  169.     [ 552609 ] fix abstract links for var and method
  170.     [ 552622 ] package-page parsing re-broken
  171.     [ 551124 ] inline links in @tags not parsed
  172.     
  173.  
  174. There of course were other small bugs fixed, these were just the bugs with 
  175. entries in source forge.  You can view the bug details or reopen it if
  176. you think it's not totally fixed at:
  177. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  178.  
  179.  
  180. Features added that had Feature Request entries in SF:
  181.     [ 557582 ] automatic linking to include pages
  182.     [ 553374 ] add links to descended methods
  183.     [ 553597 ] procedural pages should link to classes
  184.     [ 557429 ] problem with class variables
  185.     [ 557426 ] method information
  186.     [ 557427 ] i think this too
  187.     [ 557430 ] tag "company <description>"
  188.     [ 553601 ] Create a converter howto
  189.     [ 550032 ] add a link to the website and the version
  190.     [ 556454 ] Set default package name
  191.     [ 553371 ] add links to child classes
  192.     [ 550261 ] create phpdoc.de-style warning/error page
  193.     [ 550292 ] add --ignoreunknowntags
  194.     [ 549149 ] intermediary data struc btwn Render + Template
  195.     [ 551253 ] Render like Parser lookup no switch
  196.  
  197.  
  198. ################################################################################
  199.  
  200. The documentation has been updated for this release you can view it at
  201. http://phpdocu.sourceforge.net/spec/
  202. or in the distribution in the spec directory
  203.  
  204. The changelog is available in the tarball, or online at 
  205. http://phpdocu.sourceforge.net/Changelog
  206.  
  207. You can download the newest version from 
  208. http://phpdocu.sourceforge.net/downloads.php
  209.  
  210. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  211. http://phpdoc.org/ 
  212.  
  213. enjoy
  214. -joshua eichorn <jeichorn@phpdoc.org>
  215. -gregory beaver <cellog@users.sourceforge.net>
  216.  
  217.