docblock-func.inc.html

OPTIONAL Template File, included by functions_detail.inc.html

Template variables required by this page:

{sdesc} -- short description from DocBlock
{desc} -- long description from DocBlock
<params loop> --
{var} -- parameter name (like $var)
{data} -- parameter documentation parsed from a @param tag in the DocBlock
<docblock loop> --
{keyword} -- tag name
{data} -- tag information (author name in @author tag, @see link, etc.)

Document the DocBlock of functions/methods

Example:

<!-- ========== 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>