home *** CD-ROM | disk | FTP | other *** search
/ Enter 2004 June / ENTER.ISO / files / xampp-win32-1.4.5-installer.exe / xampp / Release-1.0.0rc1 < prev    next >
Encoding:
Text File  |  2004-03-24  |  6.8 KB  |  161 lines
  1. PhpDocumentor Version 1.0.0rc1        ALMOST THERE
  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. v1.0 release candidate 1.  This is a stable non-beta release candidate with
  11. all features implemented and known bugs fixed.
  12.  
  13. PHPDocumentor is a JavaDoc-like automatic documentation generator for PHP
  14. written in PHP.  It is the most versatile tool for documenting PHP.
  15.  
  16. For users new to PHPDocumentor, PHPDocumentor uses an event-driven parser
  17. and intermediary data structures that allow it to perform at a level other
  18. automatic documentors for PHP cannot achieve:
  19.   --parsing any php file, with multiple classes and functions in the same file
  20.   --fully compliant with even the most esoteric php syntax 
  21.       ($string = <<< EOF, for example)
  22.   --ability to generate multiple output formats
  23.   --extremely fast parsing
  24.   --error/warnings by line number and file to allow for debugging of
  25.     documentation tags
  26.   --multiple output templates to easily customize the look of generated
  27.     documentation
  28.   --extensive documentation of the package, including a detailed specification
  29.     for tags
  30.   --open source, GPL
  31.  
  32. Changes from version 0.4.2a include:
  33.   --resolution of many bugs
  34.   --the addition of intermediary parsing structures that nearly double parsing speed
  35.     and allow for new Converter class to process output
  36.   --improved class inheritance and package handling
  37.   --error and warning system
  38.   --improved inline documentation and external documentation
  39.  
  40. A full listing of all closed bugs and feature requests can be found in the 
  41. next section of the notes
  42.  
  43. PHPDocumentor is ready for immediate use documenting any PHP project,
  44. download it and try the most advanced solution for PHP documentation today
  45.  
  46. ################################################################################
  47.  
  48. The following bugs are fixed in version 1.0.0rc1:
  49.     [ 558056 ] Package name check to strict
  50.     [ 558031 ] Multiple @access tags causes error in IntermediateParser.inc
  51.     [ 557767 ] some indexing has wrong filename
  52.     [ 557557 ] another copy of the howto isn't helpful
  53.     [ 557060 ] document commandline switches
  54.     [ 557691 ] crash on ParserData.inc line 1501
  55.     [ 557663 ] class links on procpage unstable
  56.     [ 557669 ] phpdoc.php needs parseprivate
  57.     [ 557665 ] @var should be like @return, not @package
  58.     [ 557585 ] class trees blank if 1 class
  59.     [ 557164 ] bad copying of images n css files
  60.     [ 557570 ] no quote events called from PARSER_EVENT_DEFINE_PARAMS 
  61.     [ 557568 ] page links broken
  62.     [ 557558 ] only have 1 copy of the howto
  63.     [ 55754a ] 2bg_left.png in l0l33t isn't valid png
  64.     [ 557390 ] asterisks in docblock not parsed
  65.     [ 557384 ] same fix for @package needed for @var
  66.     [ 557164 ] bad copying of images n css files
  67.     [ 557523 ] update converter docs
  68.     [ 557468 ] parserClass::getChildList() broken
  69.     [ 557466 ] class tree not always working
  70.     [ 556991 ] Directory names and module names
  71.     [ 553746 ] Template directory not getting set
  72.     [ 556894 ] Methods not Inheirited when subpackage different
  73.     [ 556984 ] @see anchor tags and htmlentities
  74.     [ 556860 ] strange, */ is parsed function name
  75.     [ 556625 ] document new Classes.inc
  76.     [ 556863 ] $element->fileAlias undefined line 760
  77.     [ 556838 ] Parser.inc warning
  78.     [ 556768 ] procedural page links to wrong thing
  79.     [ 550571 ] php Warnings undefined index
  80.     [ 556451 ] Element summary duplicate/missing links
  81.     [ 556222 ] warning on line 752 NewRender
  82.     [ 556031 ] inherited indexing of methods broken
  83.     [ 556034 ] order of parsing important
  84.     [ 553607 ] linking across packages works
  85.     [ 555805 ] index proc. pages by file not name
  86.     [ 555803 ] blank index entries
  87.     [ 555800 ] empty procedural pages in index
  88.     [ 554712 ] & references parsed incorrectly
  89.     [ 554422 ] HOWTO 0.4 isn't formatted properly
  90.     [ 553615 ] @abstract always says function
  91.     [ 553559 ] multiple elements in index
  92.     [ 553609 ] class package inheritance slightly broke
  93.     [ 555768 ] if inline tag improperly closed, fails
  94.     [ 553614 ] parsing broken on parserBase
  95.     [ 555759 ] multiple var declarations screwy
  96.     [ 550489 ] comments with # not handled
  97.     [ 552615 ] document new stuff
  98.     [ 541886 ] ignore path and directory do not work
  99.     [ 553073 ] make package-level parsing pre-render
  100.     [ 551120 ] parens in include not handled
  101.     [ 553135 ] array missing from array('1', '2', '3' =
  102.     [ 553560 ] error in long strings with {@link}
  103.     [ 553393 ] generatepkgelementindex broken
  104.     [ 553158 ] problem with package indexing
  105.     [ 553138 ] links to $varname in class broken
  106.     [ 553137 ] Linker comma-delimited @see broken
  107.     [ 552611 ] fix inheritance overriding
  108.     [ 553043 ] Constructor Should be Documented Seperat
  109.     [ 552620 ] some classes not parsed
  110.     [ 552612 ] fix crash on parserDocBlock added to pac
  111.     [ 552976 ] package-level assigned to wrong package
  112.     [ 552621 ] getLink in ParserData.inc broken
  113.     [ 552609 ] fix abstract links for var and method
  114.     [ 552622 ] package-page parsing re-broken
  115.     [ 551124 ] inline links in @tags not parsed
  116.     
  117.  
  118. There of course were other small bugs fixed, these were just the bugs with 
  119. entries in source forge.  You can view the bug details or reopen it if
  120. you think it's not totally fixed at:
  121. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  122.  
  123.  
  124. Features added that had Feature Request entries in SF:
  125.     [ 557582 ] automatic linking to include pages
  126.     [ 553374 ] add links to descended methods
  127.     [ 553597 ] procedural pages should link to classes
  128.     [ 557429 ] problem with class variables
  129.     [ 557426 ] method information
  130.     [ 557427 ] i think this too
  131.     [ 557430 ] tag "company <description>"
  132.     [ 553601 ] Create a converter howto
  133.     [ 550032 ] add a link to the website and the version
  134.     [ 556454 ] Set default package name
  135.     [ 553371 ] add links to child classes
  136.     [ 550261 ] create phpdoc.de-style warning/error page
  137.     [ 550292 ] add --ignoreunknowntags
  138.     [ 549149 ] intermediary data struc btwn Render + Template
  139.     [ 551253 ] Render like Parser lookup no switch
  140.  
  141.  
  142. ################################################################################
  143.  
  144. The documentation has been updated for this release you can view it at
  145. http://phpdocu.sourceforge.net/spec/
  146. or in the distribution in the spec directory
  147.  
  148. The changelog is available in the tarball, or online at 
  149. http://phpdocu.sourceforge.net/Changelog
  150.  
  151. You can download the newest version from 
  152. http://phpdocu.sourceforge.net/downloads.php
  153.  
  154. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  155. http://phpdoc.org/ 
  156.  
  157. enjoy
  158. -joshua eichorn <jeichorn@phpdoc.org>
  159. -gregory beaver <cellog@users.sourceforge.net>
  160.  
  161.