Re: [SMARTY] PHPDoc and Smarty

From: Date: Thu, 30 Jan 2003 21:15:14 +0000
Subject: Re: [SMARTY] PHPDoc and Smarty
References: 1 2  Groups: php.smarty.dev php.smarty.general 
Request: Send a blank email to php-smarty-dev+get-654@lists.php.net to get a copy of this message
Hi, The phpdoc looks pretty good :). There's a few changes to make it fully compliant. The spec is available at: http://www.phpdoc.org/docs/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_ta gs.pkg.html First, tags should go after description, otherwise the description will be placed into the text of a tag. @param type $varname instead of @param $varname type otherwise, it is really quite beautiful :) If you're inspired, use the @var tag in the docblock of a var to specify the type as in: /** * @var string */ var $_config_path = ""; Also, it might be useful to use docblock templates as in: /**#@+ * @access private */ var $_config_path = ""; var $_config_data = array(); var $_separator = ""; /**#@-*/ This will block everything between the delimiters as having @access private. Can't wait for the next release :) Greg -- phpDocumentor http://www.phpdoc.org "Monte Ohrt" <monte@ispi.net> wrote in message news:1043881995.30853.51.camel@lena.ispi.prv... > well that was a bigger task than first thought... > > The new comment format is committed, let me know what I messed up ;-) > > Monte > > On Tue, 2003-01-28 at 21:35, Greg Beaver wrote: > > Hello all, > > > > phpDocumentor (http://www.phpdoc.org) has made Smarty its primary template > > engine for generating output, which is working wonderfully. I was wondering > > if there are any plans to convert Smarty's comments into phpDocumentor-style > > comments, as this would be very convenient. The comments are fine, nothing > > need be changed except the delimiters to > > /** > > * > > */ > > instead of > > /*====*\ > > \*====*/ > > > > and possibly adding a few tags. > > > > This would make things easier for us here. > > > > Thanks, > > Greg > > -- > > phpDocumentor > > http://www.phpdoc.org > -- > Monte Ohrt <monte@ispi.net> >

« previous php.smarty.dev (#654) next »