functions_detail.inc.html

OPTIONAL template file, included by class.html, page.html

Template variables required by this page:

{type} -- "Function" or "Method"
<function_detail loop>
{function_name} -- name of the function
{function_return} -- return value of the function, from the @return tag in the DocBlock
{function_call} -- function definition (like: function($param1, [$param2 = 'notrequired']))
{descmethod} -- empty for functions, a comma-delimited list of links to documentation for methods that override this function in child classes for methods, generated by parserClass::getOverridingMethods() and formatted by HTMLConverter::getFormattedDescMethods()

From docblock-func.inc.html

{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.)

Information about functions/methods

Example:

<!-- ============ FUNCTION DETAIL =========== -->

<A NAME='function_detail'></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
   <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
      <TD>
         <FONT SIZE='+2'><B>{type} Detail</B></FONT>
      </TD>
   </TR>
</TABLE>

<loop name="function_detail">
<A NAME='{function_name}'><!-- --></A><H3>{function_name}</H3>
<P><B>{function_return} {function_call}</B></P>
<P>{descmethod}</P>
<include filename="docblock-func.inc.html"/>
<HR>
</loop name="function_detail">