home *** CD-ROM | disk | FTP | other *** search
/ Enter 2004 June / ENTER.ISO / files / xampp-win32-1.4.5-installer.exe / xampp / Release-0.4.1 < prev    next >
Encoding:
Text File  |  2004-03-24  |  3.6 KB  |  84 lines
  1. PhpDocumentor Version 0.4.1    The BETA Release
  2. ################################################################################
  3. ################################################################################
  4.  
  5. This release brings PhpDocumentor to a new level.  PhpDocumentor is now capable of
  6. parsing any project documented with the parser from phpdoc.de in mind, as well
  7. as projects that will make phpdoc.de's parser choke.
  8.  
  9. PhpDocumentor is fully ready for parsing of any project.
  10.  
  11. We added support for:
  12. * documenting include/require/include_once/require_once
  13. * @param without a variable name (phpdoc.de style), the parser is smart and fills it in
  14. * @var to specify a class variable's type
  15. * inheritance of package/subpackage to classes, so you don't have to add a DocBlock with @package to every child class
  16. * class trees by package
  17. * default package is not documented if nothing is in it, generated docs can be used right out of the box
  18.  
  19. We changed the parser from a long switch statement to a lookup function table, with a
  20. slight improvement in speed, which is dramatic for large projects, as well as allowing
  21. much more detailed documentation of the parser.
  22.  
  23. Thanks to Gregory Beaver <cellog@users.sourceforge.net> for all his help on
  24. making this release possible.  He will be gone until late May so development
  25. will slow down for a bit, but don't worry 1.0 will be released before he gets 
  26. back.
  27.  
  28. The plan to update the template engine has been pushed to 1.0.  This will change
  29. the basic syntax for loops and includes, I will provide documentation so anyone
  30. who has custom templates should be able to make a quick update to the new engine.
  31. Also if you have a custom template and you think others would enjoy email it to
  32. me, or post it on the SF site and i'll include it in the main release.
  33.  
  34. TODO for 1.0:
  35. * add warnings/errors like phpdoc.de with line number information.
  36. * add template HOWTO
  37. * continue to improve and update documentation as features are added
  38. * improve the web interface
  39. * make a spiffy new default template, perhaps a few others
  40. * specific ordering of tag output
  41.  
  42. ################################################################################
  43.  
  44. The following bugs are fixed in version 0.4.1:
  45.     [ 547212 ] document new event handler functions
  46.     [ 547435 ] @see subdirectory still broken
  47.     [ 547433 ] l0l33t inherited templates broken
  48.     [ 546987 ] inheritance from diff package broken
  49.     [ 547233 ] generated docs online have linker bug
  50.     [ 547225 ] some classes parsed many, some none
  51.     [ 547224 ] procedural page name disappears
  52.     [ 546994 ] @tags in mid-short desc broken
  53.     [ 543608 ] @tag with multiple-line description warn
  54.     [ 545516 ] 0.4.0-Beta DataDocBlock::listKeywords()
  55.  
  56. There of course were other small bugs fixed, these were just the bugs with 
  57. entries in source forge.  You can view the bug details or reopen it if
  58. you think its not totaly fixed at:
  59. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  60.  
  61. Just change the filters to see all Bugs.
  62.  
  63. Features added that had Feature Request entries in SF:
  64.     [ 541901 ] Use first @package for procedural
  65.     
  66.  
  67. ################################################################################
  68.  
  69. The documentation has been updated for this release you can view it at
  70. http://phpdocu.sourceforge.net/howto.php
  71.  
  72. The changelog is available in the tarball, or online at 
  73. http://phpdocu.sourceforge.net/Changelog
  74.  
  75. You can download the newest version from 
  76. http://phpdocu.sourceforge.net/downloads.php
  77.  
  78. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  79. http://phpdoc.org/ 
  80.  
  81. enjoy
  82. -joshua eichorn
  83. jeichorn@phpdoc.org
  84.