home *** CD-ROM | disk | FTP | other *** search
/ Enter 2004 June / ENTER.ISO / files / xampp-win32-1.4.5-installer.exe / xampp / Release-1.1.0rc2 < prev    next >
Encoding:
Text File  |  2004-03-24  |  9.2 KB  |  207 lines
  1. $Id: Release-1.1.0rc2,v 1.8 2002/06/18 04:06:59 jeichorn Exp $
  2.  
  3. PhpDocumentor Version 1.1.0    Release Candidate 2
  4. ################################################################################
  5. http://www.phpdoc.org
  6. Joshua Eichorn jeichorn@phpdoc.org
  7. Gregory Beaver cellog@users.sourceforge.net
  8. ################################################################################
  9. ################################################################################
  10.  
  11. The phpDocumentor team would like to announce the release of phpDocumentor
  12. 1.1.0 Release Candidate 2.  This release has all known bugs fixed and all 
  13. new features implemented, and all documentation is final.  The only thing
  14. that will be changed in the release of 1.1.0 is any bugs that are in 1.1.0rc2
  15.  
  16. phpDocumentor is a JavaDoc-like automatic documentation generator for PHP
  17. written in PHP.  It is the most versatile tool for documenting PHP.
  18.  
  19. This version brings a new level of stability and speed to automatic
  20. documentation of PHP code.  Fully 25% faster than version 1.0, this version
  21. features new abilities to document global variables, static function variables,
  22. and makes writing a Converter for other output formats much simpler.
  23. In addition, phpDocumentor version 1.1.0 can directly document a CVS root, the first
  24. autodocumentor to have this ability.
  25.  
  26. There are a number of new output possibilities added in rc2.  PDF, CHM, and html
  27. using the Smarty Template engine have been added.  All are still considered alpha
  28. quality code, but feedback, errors reports and patches would be very helpful.
  29.  
  30. The Smarty driven output will be the default output in the 1.2 time period.
  31.  
  32. NOTE: Version 1.1.0 has a different command-line syntax using -o or --output.
  33.  
  34. For users new to phpDocumentor, phpDocumentor uses an event-driven parser
  35. and intermediary data structures that allow it to perform at a level other
  36. automatic documentors for PHP cannot achieve:
  37.   --parsing any php file, with multiple classes and functions in the same file
  38.   --fully compliant with even the most esoteric php syntax 
  39.       ($string = <<< EOF, for example)
  40.   --ability to generate multiple output formats
  41.   --extremely fast parsing
  42.   --error/warnings by line number and file to allow for debugging of
  43.     documentation tags
  44.   --multiple output templates to easily customize the look of generated
  45.     documentation
  46.   --extensive documentation of the package, including a detailed specification
  47.     for tags and the included template engine
  48.   --open source, GPL
  49.  
  50. Changes from version 1.1.0rc1 include:
  51.   --major improvement to the PDF Converter, it uses a pre-release of Cpdf with bookmarks
  52.   --addition of a new, very nice HTML converter based on the Smarty template
  53.   --addition of a new pre-alpha CHM converter (only works in windows, because it requires MS HTML Help Workshop)
  54.   --fixes to small template bugs that affect HTMLdefaultConverter output
  55.   --fixes to large linking bugs caused by IntermediateParser sorting introduced in 1.1
  56.   --fix a parsing bug if a tag (not the first) has a space after its opening @ like @ param
  57.   --fix for @param &$parameter
  58.   --inline documentation completed for new elements and revised for old
  59.   --added makedoc.sh, that can be used to build project documentations. More info in
  60.   README file and inside its comments.
  61.  
  62.   
  63. Changes from version 1.0.0 include:
  64.   --NEW COMMAND-LINE SYNTAX -o format:convertername:template (like PDF:default:default
  65.     or HTML:default:DOM/l0l33t)
  66.   --fixes to rare bugs that affect very large projects with many packages
  67.   --automatic linking to elements in any package
  68.   --greatly improved inheritance and @package tag handling.  Procedural pages
  69.     can now inherit the package of classes defined in them, and vice-versa.
  70.   --addition of ProceduralPages class simplifies Converter writing immensely
  71.   --pre-alpha PDF Converter that uses Wayne Munro's public domain Cpdf library
  72.   --simple commandline for output: -o outputformat:convertername:templatename, so
  73.     to use the default HTML template with the DOM/l0l33t template, use
  74.     -o HTML:default:DOM/l0l33t.
  75.  
  76. A full listing of all closed bugs and feature requests can be found in the 
  77. next section of the notes
  78.  
  79. PHPDocumentor is ready for immediate use documenting any PHP project,
  80. download it and try the most advanced solution for PHP documentation today
  81.  
  82. ################################################################################
  83.  
  84. The following bugs are fixed in version 1.1.0rc2
  85.         [ 569004 ] Unable to allocate 34 bytes
  86.         [ 568870 ] Not writing
  87.     [ 569126 ] Undefined constant
  88.     [ 568900 ] Long description starting in first line
  89.     [ 568901 ] Short description termination
  90.     [ 568979 ] Random Class Parsing? 
  91.     [ 568146 ] packageoutput breaks
  92.     [ 568131 ] getLink behavior diff. from docs
  93.     [ 568135 ] needs adv_htmlentities on default vals
  94.     [ 568137 ] {function_conflict} is {global_conflict} 
  95.     [ 567455 ] Wrong Header, Body parsing
  96.     [ 567757 ] most of file with <<< EOF quotes not parsed
  97.     [ 567681 ] need whitespace in handleGlobalValue
  98.     [ 567683 ] 3rd class in tree is always blank
  99.     [ 567578 ] Element index by package not sorted
  100.     [ 567652 ] crash when dupe class removed
  101.     [ 567654 ] if class::method() doesn't exist, wrong 
  102.     [ 567105 ] errors.html without error text 
  103.     [ 567504 ] Wrong Linking
  104.     [ 567090 ] {date} not replaced
  105.     [ 567059 ] space between @ and param
  106.     [ 563946 ] document all new stuff
  107.     [ 566659 ] @param &$arg descrip broken
  108.     [ 566607 ] HTMLdefault not copying image files
  109.     [ 566663 ] @param &$arg descrip broken
  110.     [ 566600 ] method/var links to .html
  111.     [ 566655 ] blank.html not written
  112.  
  113. The following bugs are fixed in version 1.1.0rc1
  114.     
  115.     [ 566200 ] incorrect param parsing
  116.     [ 565802 ] l0l33t include block show file docblock
  117.     [ 565559 ] l0l33t include block show file docblock
  118.     [ 564681 ] no docblocks, no packages.html
  119.     [ 564624 ] SDesc not doing {@link} right 
  120.     [ 564630 ] element index needs $local = false
  121.     [ 564135 ] class trees include @access private
  122.     [ 564174 ] method file doesn't exist
  123.     [ 563992 ] undefined index on line 861 in Converter
  124.     [ 564136 ] some classes in $roots that aren't
  125.     [ 564180 ] package_parents not organized right
  126.     [ 564173 ] global var still looked for
  127.     [ 563995 ] li_0.html
  128.     [ 564115 ] $par set to 0 in Converter::getLink()
  129.     [ 564108 ] crash when package#el package not found
  130.     [ 562653 ] General Parsing Stage Error
  131.     [ 563487 ] RE 562653 General Parsing Stage Error
  132.     [ 563729 ] some default values not showing up
  133.     [ 560603 ] raise error on unknown command-line
  134.     [ 562252 ] command line: ignore directories
  135.     [ 562057 ] fixes for directory permissions
  136.     [ 561093 ] No links to other packages in pckg el.i.
  137.     [ 561082 ] Still "half-sorted" classtree
  138.     [ 561101 ] if (is_object()) missing?
  139.     [ 560675 ] packageoutput still broken
  140.     [ 561396 ] many pages not in left.html index
  141.     [ 563005 ] func_global handler broken
  142.     [ 562997 ] class parsed out of string in php code
  143.     [ 561394 ] fatal error on ProceduralPages line 329
  144.     [ 561392 ] undefined offset on line 874
  145.     [ 561084 ] Wrong links - phpdoc.de
  146.     [ 561073 ] Bad characters... htmlentities()
  147.     [ 560677 ] most links to examples broken
  148.     [ 560604 ] phpdoc -h cuts off defaultpackagename
  149.     [ 560630 ] document new tag usage
  150.     [ 560598 ] Fatal error while using the -po option
  151.     [ 560532 ] require_once() docblock is not parsed
  152.     [ 560595 ] warning on 1375 of Parser.inc
  153.     [ 560578 ] @author test @ fails
  154.     [ 560202 ] docblock_desc not formatted correctly
  155.     [ 560377 ] package-level docs parsed, not shown
  156.     [ 560021 ] memory_limit
  157.  
  158. There of course were other small bugs fixed, these were just the bugs with 
  159. entries in source forge.  You can view the bug details or reopen it if
  160. you think it's not totally fixed at:
  161. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  162.  
  163.  
  164. Features added that had Feature Request entries in SF:
  165.     [ 559216 ] /style /image directories
  166.     [ 553600 ] Update the Template Engine
  167.     [ 541902 ] Create a new Default Template
  168.     [ 561950 ] No frames in output 
  169.     [ 563370 ] new Converter for another template 
  170.     [ 553599 ] document static variables
  171.     [ 556757 ] add javadoc desc compliance switch
  172.     [ 558117 ] inherit from other packages, if possible
  173.     [ 558757 ] add Functions to left.html
  174.     [ 559339 ] add new parserEmail for <a@b>
  175.     [ 560026 ] Auto-links to different packages broken
  176.     [ 560375 ] need setWhitespace at start
  177.     [ 560586 ] add full phpdoc.de support for @name
  178.     [ 560888 ] document name conflicts
  179.     [ 560891 ] make @param do type $varname
  180.     [ 560892 ] check var type, param type for class
  181.     [ 561081 ] Better Elementindex
  182.     [ 561941 ] cvs files documentation 
  183.     [ 562650 ] parent:: keyword is not processed?
  184.  
  185.  
  186. ################################################################################
  187.  
  188. The documentation has been updated for this release you can view it at
  189. http://phpdocu.sourceforge.net/spec/
  190. or in the distribution in the spec directory
  191.  
  192. The changelog is available in the tarball, or online at 
  193. http://phpdocu.sourceforge.net/Changelog
  194.  
  195. You can download the newest version from 
  196. http://phpdocu.sourceforge.net/downloads.php
  197.  
  198. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  199. http://phpdoc.org/ 
  200.  
  201. enjoy
  202. -joshua eichorn <jeichorn@phpdoc.org>
  203. -gregory beaver <cellog@users.sourceforge.net>
  204.  
  205.  
  206. vim: set expandtab :
  207.