home *** CD-ROM | disk | FTP | other *** search
/ Enter 2004 June / ENTER.ISO / files / xampp-win32-1.4.5-installer.exe / xampp / Release-1.1.0 < prev    next >
Encoding:
Text File  |  2004-03-24  |  11.2 KB  |  253 lines
  1. $Id: Release-1.1.0,v 1.2 2002/12/05 04:24:51 jeichorn Exp $
  2.  
  3. PhpDocumentor Version 1.1.0 FINAL
  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 FINAL.  This release has all known bugs fixed and all 
  13. new features implemented.
  14.  
  15. IMPORTANT: phpDocumentor 1.1.0 FINAL requires PHP version 4.1.0 or greater. Previous
  16. versions, including the release candidate 2 required 4.0.6 or greater.  Please upgrade
  17. if you are using 4.0.6, phpDocumentor will not work properly.
  18.  
  19. phpDocumentor is a JavaDoc-like automatic documentation generator for PHP
  20. written in PHP.  It is the most versatile tool for documenting PHP.
  21.  
  22. This version brings a new level of stability and speed to automatic
  23. documentation of PHP code.  Fully 25% faster than version 1.0, this version
  24. features new abilities to document global variables, static function variables,
  25. and makes writing a Converter for other output formats much simpler.
  26. In addition, phpDocumentor version 1.1.0 can directly document a CVS root, the first
  27. autodocumentor to have this ability.
  28.  
  29. There are a number of new output possibilities added in rc2 have stabilized.  The new
  30. Smarty Template Converter is fully functional.  The PDF, and CHM Converters are both
  31. ALPHA, repeat NOT FINAL code with many bugs and problems.  These will be addressed for
  32. the next release.
  33.  
  34. The Smarty driven output will be the default output in the 1.2 time period.
  35.  
  36. NOTE: Version 1.1.0 has a different command-line syntax using -o or --output.
  37.  
  38. For users new to phpDocumentor, phpDocumentor uses an event-driven parser
  39. and intermediary data structures that allow it to perform at a level other
  40. automatic documentors for PHP cannot achieve:
  41.   --parsing any php file, with multiple classes and functions in the same file
  42.   --fully compliant with even the most esoteric php syntax 
  43.       ($string = <<< EOF, for example)
  44.   --ability to generate multiple output formats
  45.   --extremely fast parsing
  46.   --error/warnings by line number and file to allow for debugging of
  47.     documentation tags
  48.   --multiple output templates to easily customize the look of generated
  49.     documentation
  50.   --extensive documentation of the package, including a detailed specification
  51.     for tags and the included template engine
  52.   --open source, GPL
  53.   
  54. Changes from version 1.1.0rc2 include:
  55.   --VAST improvement in the pre-alpha PDF Converter, uses Cpdf version 0.09, no warnings (finally)
  56.   --all known bugs are fixed in the non-alpha code.
  57.   --major improvements to the Smarty templates
  58.   --many bugfixes listed below
  59.   --addition of a new template for the default HTML Converter, phphtmllib.  It only works with
  60.     a project that has one package.  Be advised.  This template courtesy of
  61.     Walter Boring IV (http://phphtmllib.newsblob.com/)
  62.  
  63. Changes from version 1.1.0rc1 include:
  64.   --major improvement to the PDF Converter, it uses a pre-release of Cpdf with bookmarks
  65.   --addition of a new, very nice HTML converter based on the Smarty template
  66.   --addition of a new pre-alpha CHM converter (only works in windows, because it requires MS HTML Help Workshop)
  67.   --fixes to small template bugs that affect HTMLdefaultConverter output
  68.   --fixes to large linking bugs caused by IntermediateParser sorting introduced in 1.1
  69.   --fix a parsing bug if a tag (not the first) has a space after its opening @ like @ param
  70.   --fix for @param &$parameter
  71.   --inline documentation completed for new elements and revised for old
  72.   --added makedoc.sh, that can be used to build project documentations. More info in
  73.   README file and inside its comments.
  74.  
  75.   
  76. Changes from version 1.0.0 include:
  77.   --NEW COMMAND-LINE SYNTAX -o format:convertername:template (like PDF:default:default
  78.     or HTML:default:DOM/l0l33t)
  79.   --fixes to rare bugs that affect very large projects with many packages
  80.   --automatic linking to elements in any package
  81.   --greatly improved inheritance and @package tag handling.  Procedural pages
  82.     can now inherit the package of classes defined in them, and vice-versa.
  83.   --addition of ProceduralPages class simplifies Converter writing immensely
  84.   --pre-alpha PDF Converter that uses Wayne Munro's public domain Cpdf library
  85.   --simple commandline for output: -o outputformat:convertername:templatename, so
  86.     to use the default HTML template with the DOM/l0l33t template, use
  87.     -o HTML:default:DOM/l0l33t.
  88.  
  89. A full listing of all closed bugs and feature requests can be found in the 
  90. next section of the notes
  91.  
  92. PHPDocumentor is ready for immediate use documenting any PHP project,
  93. download it and try the most advanced solution for PHP documentation today
  94.  
  95. ################################################################################
  96.  
  97. The following bugs are fixed in version 1.1.0 FINAL
  98. Request ID Summary Date Assigned To Submitted By 
  99.     [ 635264 ] -po crashes on inter-package conflict
  100.     [ 634492 ] Linking not working to child in Smarty
  101.     [ 631853 ] sometimes, first letter is cut off
  102.     [ 631842 ] default value of '' is ignored
  103.     [ 631626 ] need pre-like for desc/sdesc
  104.     [ 625686 ] typo in HTML:default:DOM/default templat
  105.     [ 623054 ] render->addConverter
  106.     [ 623053 ] Link to Class Trees
  107.     [ 623048 ] parserTag::Convert
  108.     [ 621416 ] html mistake
  109.     [ 608989 ] @param ignored
  110.     [ 604406 ] command line option -o' can't delete
  111.     [ 604254 ] Prepended space in multi-line summaries 
  112.     [ 603668 ] wrong doctype in some tamplate
  113.     [ 603660 ] register global off
  114.     [ 599005 ] Function Proto no longer has return type
  115.     [ 598910 ] Procedural Page Doc does not work
  116.     [ 597089 ] PDF: page # after TOC assumed as 2 
  117.     [ 597086 ] PDF: font Helvetica not included in rel.
  118.     [ 591396 ] @package in extended classes
  119.     [ 588453 ] default func.parameters
  120.     [ 587737 ] multi-line function name bug
  121.     [ 587733 ] inherited private methods visible
  122.     [ 582360 ] can't find package page
  123.     [ 578143 ] custom flags not in command line section
  124.     [ 576507 ] @global type desc First word cut off
  125.     [ 575232 ] Open short tags off problem
  126.     [ 573532 ] Errata in spec/tags/tags.ignore.html
  127.     [ 571677 ] remarks after @return TYPE not shown 
  128.  
  129.  
  130. The following bugs are fixed in version 1.1.0rc2
  131.     [ 569004 ] Unable to allocate 34 bytes
  132.     [ 568870 ] Not writing
  133.     [ 569126 ] Undefined constant
  134.     [ 568900 ] Long description starting in first line
  135.     [ 568901 ] Short description termination
  136.     [ 568979 ] Random Class Parsing? 
  137.     [ 568146 ] packageoutput breaks
  138.     [ 568131 ] getLink behavior diff. from docs
  139.     [ 568135 ] needs adv_htmlentities on default vals
  140.     [ 568137 ] {function_conflict} is {global_conflict} 
  141.     [ 567455 ] Wrong Header, Body parsing
  142.     [ 567757 ] most of file with <<< EOF quotes not parsed
  143.     [ 567681 ] need whitespace in handleGlobalValue
  144.     [ 567683 ] 3rd class in tree is always blank
  145.     [ 567578 ] Element index by package not sorted
  146.     [ 567652 ] crash when dupe class removed
  147.     [ 567654 ] if class::method() doesn't exist, wrong 
  148.     [ 567105 ] errors.html without error text 
  149.     [ 567504 ] Wrong Linking
  150.     [ 567090 ] {date} not replaced
  151.     [ 567059 ] space between @ and param
  152.     [ 563946 ] document all new stuff
  153.     [ 566659 ] @param &$arg descrip broken
  154.     [ 566607 ] HTMLdefault not copying image files
  155.     [ 566663 ] @param &$arg descrip broken
  156.     [ 566600 ] method/var links to .html
  157.     [ 566655 ] blank.html not written
  158.  
  159. The following bugs are fixed in version 1.1.0rc1
  160.     
  161.     [ 566200 ] incorrect param parsing
  162.     [ 565802 ] l0l33t include block show file docblock
  163.     [ 565559 ] l0l33t include block show file docblock
  164.     [ 564681 ] no docblocks, no packages.html
  165.     [ 564624 ] SDesc not doing {@link} right 
  166.     [ 564630 ] element index needs $local = false
  167.     [ 564135 ] class trees include @access private
  168.     [ 564174 ] method file doesn't exist
  169.     [ 563992 ] undefined index on line 861 in Converter
  170.     [ 564136 ] some classes in $roots that aren't
  171.     [ 564180 ] package_parents not organized right
  172.     [ 564173 ] global var still looked for
  173.     [ 563995 ] li_0.html
  174.     [ 564115 ] $par set to 0 in Converter::getLink()
  175.     [ 564108 ] crash when package#el package not found
  176.     [ 562653 ] General Parsing Stage Error
  177.     [ 563487 ] RE 562653 General Parsing Stage Error
  178.     [ 563729 ] some default values not showing up
  179.     [ 560603 ] raise error on unknown command-line
  180.     [ 562252 ] command line: ignore directories
  181.     [ 562057 ] fixes for directory permissions
  182.     [ 561093 ] No links to other packages in pckg el.i.
  183.     [ 561082 ] Still "half-sorted" classtree
  184.     [ 561101 ] if (is_object()) missing?
  185.     [ 560675 ] packageoutput still broken
  186.     [ 561396 ] many pages not in left.html index
  187.     [ 563005 ] func_global handler broken
  188.     [ 562997 ] class parsed out of string in php code
  189.     [ 561394 ] fatal error on ProceduralPages line 329
  190.     [ 561392 ] undefined offset on line 874
  191.     [ 561084 ] Wrong links - phpdoc.de
  192.     [ 561073 ] Bad characters... htmlentities()
  193.     [ 560677 ] most links to examples broken
  194.     [ 560604 ] phpdoc -h cuts off defaultpackagename
  195.     [ 560630 ] document new tag usage
  196.     [ 560598 ] Fatal error while using the -po option
  197.     [ 560532 ] require_once() docblock is not parsed
  198.     [ 560595 ] warning on 1375 of Parser.inc
  199.     [ 560578 ] @author test @ fails
  200.     [ 560202 ] docblock_desc not formatted correctly
  201.     [ 560377 ] package-level docs parsed, not shown
  202.     [ 560021 ] memory_limit
  203.  
  204. There of course were other small bugs fixed, these were just the bugs with 
  205. entries in source forge.  You can view the bug details or reopen it if
  206. you think it's not totally fixed at:
  207. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  208.  
  209.  
  210. Features added that had Feature Request entries in SF:
  211.     [ 559216 ] /style /image directories
  212.     [ 553600 ] Update the Template Engine
  213.     [ 541902 ] Create a new Default Template
  214.     [ 561950 ] No frames in output 
  215.     [ 563370 ] new Converter for another template 
  216.     [ 553599 ] document static variables
  217.     [ 556757 ] add javadoc desc compliance switch
  218.     [ 558117 ] inherit from other packages, if possible
  219.     [ 558757 ] add Functions to left.html
  220.     [ 559339 ] add new parserEmail for <a@b>
  221.     [ 560026 ] Auto-links to different packages broken
  222.     [ 560375 ] need setWhitespace at start
  223.     [ 560586 ] add full phpdoc.de support for @name
  224.     [ 560888 ] document name conflicts
  225.     [ 560891 ] make @param do type $varname
  226.     [ 560892 ] check var type, param type for class
  227.     [ 561081 ] Better Elementindex
  228.     [ 561941 ] cvs files documentation 
  229.     [ 562650 ] parent:: keyword is not processed?
  230.  
  231.  
  232. ################################################################################
  233.  
  234. The documentation has been updated for this release you can view it at
  235. http://phpdocu.sourceforge.net/spec/
  236. or in the distribution in the spec directory
  237.  
  238. The changelog is available in the tarball, or online at 
  239. http://phpdocu.sourceforge.net/Changelog
  240.  
  241. You can download the newest version from 
  242. http://phpdocu.sourceforge.net/downloads.php
  243.  
  244. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  245. http://phpdoc.org/ 
  246.  
  247. enjoy
  248. -joshua eichorn <jeichorn@phpdoc.org>
  249. -gregory beaver <cellog@users.sourceforge.net>
  250.  
  251.  
  252. vim: set expandtab :
  253.