{sdesc} -- short description from DocBlock
{desc} -- long description from DocBlock
<params loop> --
{var} -- parameter name (like $var)<docblock loop> --
{data} -- parameter documentation parsed from a @param tag in the DocBlock
{keyword} -- tag name
{data} -- tag information (author name in @author tag, @see link, etc.)
Document the DocBlock of functions/methods
<!-- ========== Info from phpDoc block ========= -->
<b>{sdesc}</b>
<pre>
{desc}
</pre>
<DL>
<DT>Function Parameters:</DT>
<loop name="params">
<DD>- <CODE><i>{var}</i> {data}</CODE></DD>
</loop name="params">
<DT>Function Info:</DT>
<loop name="docblock">
<DD><b>{keyword}</b> - <CODE>{data}</CODE></DD>
</loop name="docblock">
</DL>
Prev | Home | Next |
docblock.inc.html template file | Up | functions_inherited.inc.html template file |
Template Documentation written by Gregory Beaver <cellog@users.sourceforge.net> and Joshua Eichorn <jeichorn@phpdoc.org>
Copyright © 2002, Gregory Beaver, Joshua Eichorn