introduction, and phpDocumentor 1.1
| From: | Greg Beaver | Date: | Fri, 14 Jun 2002 21:49:47 +0000 |
| Subject: | introduction, and phpDocumentor 1.1 | ||
| Groups: | php.smarty.general | ||
| Request: | Send a blank email to php-smarty-general+get-4873@lists.php.net to get a copy of this message | ||
Hello everyone,
I want to introduce myself as one of the developers for phpDocumentor
(http://www.phpdoc.org). We have developed an extensible automatic
documentor that is quite powerful. One of the features we are including in
the next release is a converter for the Smarty template, which we're very
excited about.
phpDocumentor can also output HTML with a primitive template engine, PDF
directly using the Cezpdf library, and we'll be adding formats such as
DocBook, CHM, and others over the next year.
I found that the auto-documentor attempted to document our compiled template
files when run on itself, and patched Smarty_Compiler.class.php by replacing
lines 186-7 with:
// put header at the top of the compiled template
$template_header = "<?php /** Smarty version ".$this->_version.",
created on ".strftime("%Y-%m-%d %H:%M:%S")."\n";
$template_header .= " * compiled from ".$tpl_file." \n
* @ignore */\n/** @global string $notused */\n\$notused=\$notused; ?>\n";
I also found that most of the documentation comments in Smarty could be
modified only slightly and become valid documentation blocks for
phpDocumentor.
I'll let everyone know when the rc2 candidate comes out, we'd love to get
feedback on how we use smarty and on the documentor itself.
Take care,
Greg Beaver
--
phpDocumentor v1.1.0rc2 due out in a few days time!
http://www.phpdoc.org phpDocumentor home
http://www.sourceforge.net/projects/phpdocu
Sourceforge project page