Re: introduction, and phpDocumentor 1.1

From: Date: Thu, 20 Jun 2002 04:02:42 +0000
Subject: Re: introduction, and phpDocumentor 1.1
Groups: php.smarty.general 
Request: Send a blank email to php-smarty-general+get-4956@lists.php.net to get a copy of this message
Hi Greg, Its nice to see you here too. PHPDoc is a nice way to document your code with comments. It's like JavaDoc. You simple add some comments before functions, classes, variables, and call PHPDoc to get what you put inside your .php files and it create the .html/.pdf output. I will try to use Smarty PHPDOC Converter - that Greg is builting - to build docbook output. I dont know how to build new converters and if possible I will not to try undestand, but I hope that with Smarty PHPDOc Converter I can build a smarty template that build not a html file, but a docbook file. Maybe we can use Smarty Converter in others converter too, like a XML converter. Will be really nice to use the Smarty power in this project. A exemple of PHPDoc comment: /*** * Foo Function * * Foo function do foo things. * * @author Me <me@me.me> * @copyright Without * @param string $name Your name * @param integer $age Your age * @return array array($name,$age) */ function foo ($name,$age) { return array($name,$age); } On Fri, 14 Jun 2002 16:49:47 -0500 "Greg Beaver" <greg@chiaraquartet.net> wrote: > 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 > > > -- > Smarty General Mailing List (http://smarty.php.net/) > To unsubscribe, visit: http://www.php.net/unsub.php > Atenciosamente, --------------------------------------------------------- Roberto Bertó, e-Consultor Cel: 51 91169628 email: berto@under.com.br UNDER DEVELOPMENT - http://www.UNDER.com.br Tel/FAX: 51 32270599 Rua Duque de Caxias, 1594 apto. 204 CEP 900010-281 - Porto Alegre - RS --------------------------------------------------------- Atenciosamente, --------------------------------------------------------- Roberto Bertó, e-Consultor Cel: 51 91169628 email: berto@under.com.br UNDER DEVELOPMENT - http://www.UNDER.com.br Tel/FAX: 51 32270599 Rua Duque de Caxias, 1594 apto. 204 CEP 900010-281 - Porto Alegre - RS ---------------------------------------------------------

« previous php.smarty.general (#4956) next »