functions_summary.inc.html

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

Template variables required by this page:

{type} -- "Functions" or "Methods"
<functions loop>
{page} -- file.ext name of the current page
{function_name} -- name of the function
{function_return} -- the variable type that this function returns, or void
{function_call} -- function definition (like: function($param1, [$param2 = 'notrequired']))
{function_sdesc} -- short description, parsed from the DocBlock

Summary of all functions defined in a page or a class, feel free to write your own loop directly in class.html or page.html, although using this file simplifies things

Example:

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

   <loop name="functions">
   <!-- =========== Summary =========== -->
   <TR BGCOLOR='white' CLASS='TableRowColor'>
      <TD>
         <CODE><B><A HREF='{page}#{function_name}'>{function_return} {function_call}</A></B></CODE>
         <BR>
         <blockquote> {function_sdesc} </blockquote>
      </TD>
   </TR>
   </loop name="functions">
</TABLE>