Ongoing PHPDoc development

From: Date: Thu, 04 Apr 2002 18:49:43 +0000
Subject: Ongoing PHPDoc development
References: 1 2  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-5190@lists.php.net to get a copy of this message
I am really interested in the continued development of a PHPDoc that doesn't depend on anything in the Zend engine. It will be a while before something like that is mainstream, and furthermore, not everyone will be able to upgrade to the latest version of PHP as soon as it becomes available. My opinion is that it will be at least a year, maybe two, before a version of PHP becomes *mainstream* (lots of users) that has support in the Zend engine for parsing PHP code through native PHP function calls. With this in mind, I am interested in continuing the development of PHPDoc aggressively. I have posted a zip file with all my changes in it, posted at: http://www.smur.net/code/phpdoc4apr02.zip If one of the current maintainers of PHPDoc would consider updating CVS that would be great. As it stands, I think I've had one, maybe two people take the time to look over what I've done and comment. I've spent 20 to 30 hours on this revision to PHPDoc, and would appreciate a little bit of time from a few people on this list. (thanks!) I've been monitoring the cvs mailing list for changes to the code base and have incorporated all the changes from cvs into my code. The changes I've made are as follows. Added a web interface to phpdoc with support for multiple templates Removed apidoc/keep in favor of having static files bundled with a specific template. Renamed renderer/html/templates to renderer/html/default Moved the files from /apidoc/keep to renderer/html/default/static Added a file copying routine that copies the files in the template/static directory to the generated document directory. Added file /renderer/html/templates.php as a template setup file for multiple templates. Added two constants to prepend.php to allow the version of PHPDoc to be updated on generated documentation easily, and to provide a link to the phpdoc website on generated documentation. Added a constant used on generated documentation to display the generated date and time. Changed the default templates in renderer/html/default to use the version and link constants Modified the files needed to facilitate the changes listed above for version and link constants. Things I'd like seen done in the near future include: implementation of the @exclude tag support for multiple author tags. support for code examples (example code that would go in the generated docs) Comments? -timmyg timg@sunflowerroad dot com

« previous php.pear.dev (#5190) next »