home *** CD-ROM | disk | FTP | other *** search
/ Enter 2004 June / ENTER.ISO / files / xampp-win32-1.4.5-installer.exe / xampp / Release-1.1.0rc1 < prev    next >
Encoding:
Text File  |  2004-03-24  |  7.2 KB  |  163 lines
  1. PhpDocumentor Version 1.1.0    Release Candidate 1
  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.1.0 Release Candidate 1.  This release has all known bugs fixed and all 
  11. new features implemented.  The only thing that will be changed in the release
  12. of 1.1.0 is the documentation, and any bugs that are in 1.1.0rc1
  13.  
  14. phpDocumentor is a JavaDoc-like automatic documentation generator for PHP
  15. written in PHP.  It is the most versatile tool for documenting PHP.
  16.  
  17. This version brings a new level of stability and speed to automatic
  18. documentation of PHP code.  Fully 25% faster than version 1.0, this version
  19. features new abilities to document global variables, static function variables,
  20. and makes writing a Converter for other output formats much simpler.
  21. In addition, phpDocumentor version 1.1.0 can directly document a CVS root, the first
  22. autodocumentor to have this ability.
  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 version 1.0.0 include:
  41.   --fixes to rare bugs that affect very large projects with many packages
  42.   --automatic linking to elements in any package
  43.   --greatly improved inheritance and @package tag handling.  Procedural pages
  44.     can now inherit the package of classes defined in them, and vice-versa.
  45.   --addition of ProceduralPages class simplifies Converter writing immensely
  46.   --pre-alpha PDF Converter that uses Wayne Munro's public domain Cpdf library
  47.   --simple commandline for output: -o outputformat:convertername:templatename, so
  48.     to use the default HTML template with the DOM/l0l33t template, use
  49.     -o HTML:default:DOM/l0l33t.
  50.  
  51. Changes from version 1.0.0rc1 include:
  52.   --fixes to bugs with parsing extremely large projects
  53.   --linking to defines fixed
  54.   --new templates for dom supporting browsers that allows for 
  55.       minimizing/maximizing classes in the left list
  56.   --brand new template spec in the spec/templates directory
  57.   --better error handling, new unknown tags array in parserDocBlock for
  58.     Converter use in custom templates
  59.   
  60. Changes from version 0.4.2a include:
  61.   --resolution of many bugs
  62.   --the addition of intermediary parsing structures that nearly double parsing speed
  63.     and allow for new Converter class to process output
  64.   --improved class inheritance and package handling
  65.   --error and warning system
  66.   --improved inline documentation and external documentation
  67.  
  68. A full listing of all closed bugs and feature requests can be found in the 
  69. next section of the notes
  70.  
  71. PHPDocumentor is ready for immediate use documenting any PHP project,
  72. download it and try the most advanced solution for PHP documentation today
  73.  
  74. ################################################################################
  75.  
  76. The following bugs are fixed in version 1.1.0rc1
  77.     
  78.     [ 566200 ] incorrect param parsing
  79.     [ 565802 ] l0l33t include block show file docblock
  80.     [ 565559 ] l0l33t include block show file docblock
  81.     [ 564681 ] no docblocks, no packages.html
  82.     [ 564624 ] SDesc not doing {@link} right 
  83.     [ 564630 ] element index needs $local = false
  84.     [ 564135 ] class trees include @access private
  85.     [ 564174 ] method file doesn't exist
  86.     [ 563992 ] undefined index on line 861 in Converter
  87.     [ 564136 ] some classes in $roots that aren't
  88.     [ 564180 ] package_parents not organized right
  89.     [ 564173 ] global var still looked for
  90.     [ 563995 ] li_0.html
  91.     [ 564115 ] $par set to 0 in Converter::getLink()
  92.     [ 564108 ] crash when package#el package not found
  93.     [ 562653 ] General Parsing Stage Error
  94.     [ 563487 ] RE 562653 General Parsing Stage Error
  95.     [ 563729 ] some default values not showing up
  96.     [ 560603 ] raise error on unknown command-line
  97.     [ 562252 ] command line: ignore directories
  98.     [ 562057 ] fixes for directory permissions
  99.     [ 561093 ] No links to other packages in pckg el.i.
  100.     [ 561082 ] Still "half-sorted" classtree
  101.     [ 561101 ] if (is_object()) missing?
  102.     [ 560675 ] packageoutput still broken
  103.     [ 561396 ] many pages not in left.html index
  104.     [ 563005 ] func_global handler broken
  105.     [ 562997 ] class parsed out of string in php code
  106.     [ 561394 ] fatal error on ProceduralPages line 329
  107.     [ 561392 ] undefined offset on line 874
  108.     [ 561084 ] Wrong links - phpdoc.de
  109.     [ 561073 ] Bad characters... htmlentities()
  110.     [ 560677 ] most links to examples broken
  111.     [ 560604 ] phpdoc -h cuts off defaultpackagename
  112.     [ 560630 ] document new tag usage
  113.     [ 560598 ] Fatal error while using the -po option
  114.     [ 560532 ] require_once() docblock is not parsed
  115.     [ 560595 ] warning on 1375 of Parser.inc
  116.     [ 560578 ] @author test @ fails
  117.     [ 560202 ] docblock_desc not formatted correctly
  118.     [ 560377 ] package-level docs parsed, not shown
  119.     [ 560021 ] memory_limit
  120.  
  121. There of course were other small bugs fixed, these were just the bugs with 
  122. entries in source forge.  You can view the bug details or reopen it if
  123. you think it's not totally fixed at:
  124. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  125.  
  126.  
  127. Features added that had Feature Request entries in SF:
  128.     [ 553599 ] document static variables
  129.     [ 556757 ] add javadoc desc compliance switch
  130.     [ 558117 ] inherit from other packages, if possible
  131.     [ 558757 ] add Functions to left.html
  132.     [ 559339 ] add new parserEmail for <a@b>
  133.     [ 560026 ] Auto-links to different packages broken
  134.     [ 560375 ] need setWhitespace at start
  135.     [ 560586 ] add full phpdoc.de support for @name
  136.     [ 560888 ] document name conflicts
  137.     [ 560891 ] make @param do type $varname
  138.     [ 560892 ] check var type, param type for class
  139.     [ 561081 ] Better Elementindex
  140.     [ 561941 ] cvs files documentation 
  141.     [ 562650 ] parent:: keyword is not processed?
  142.  
  143.  
  144. ################################################################################
  145.  
  146. The documentation has been updated for this release you can view it at
  147. http://phpdocu.sourceforge.net/spec/
  148. or in the distribution in the spec directory
  149.  
  150. The changelog is available in the tarball, or online at 
  151. http://phpdocu.sourceforge.net/Changelog
  152.  
  153. You can download the newest version from 
  154. http://phpdocu.sourceforge.net/downloads.php
  155.  
  156. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  157. http://phpdoc.org/ 
  158.  
  159. enjoy
  160. -joshua eichorn <jeichorn@phpdoc.org>
  161. -gregory beaver <cellog@users.sourceforge.net>
  162.  
  163.