functions_inherited.inc.html

OPTIONAL template file, included by class.html

Template variables required by this page:

<inherited_functions loop>
{parent_class} -- parent class the methods were inherited from, includes hyperlink generated by parserClass::getInheritedMethods() and formatted by HTMLConverter::getFormattedInheritedMethods()
<ifunctions loop>
{ipath} -- file.ext name of class documentation file for parent class
{ifunction_name} -- name of the method
{ifunction_call} -- function definition (like: function($param1, [$param2 = 'notrequired']))
{ifunction_sdesc} -- short description from the DocBlock

This optional file describes methods inherited from parent classes. Use these values directly in class.html or include this file.

Example:

<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
   <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
      <TD>
         <FONT SIZE='+2'><B>Inherited Method Summary</B></FONT>
      </TD>
   </TR>

   <loop name="inherited_functions">
   <!-- =========== Summary =========== -->
   <TR BGCOLOR='white' CLASS='TableRowColor'>
      <TD>
         <FONT SIZE='+2'><B>Inherited From Class {parent_class}</B></FONT>
         <blockquote>
         <TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='95%'>
            <tr>
               <th>Function</th>
               <th>Description</th>
            </tr>
            <loop name="ifunctions">
            <tr>
               <td><CODE><B><A HREF='{ipath}#{ifunction_name}'>{ifunction_call}</A></B></CODE></td>
               <td>{ifunction_sdesc}</td>
            </loop name="ifunctions">
         </table>
         </blockquote>
      </TD>
   </TR>
   </loop name="inherited_functions">
</TABLE>