includes_summary.inc.html

OPTIONAL Template file, included by page.html

Template variables required by this page:

<includes loop>
{page} -- file.html name of the current documentation page
{include_file} -- file.ext name of the file included, use for #a name links
{include_name} -- include/require/include_once/require_once
{include_value} -- file included (same as include_file in 1.0, this may change)
{include_sdesc} -- short description from DocBlock

Include File Summary Details

Example:

<!-- =========== CONSTANT SUMMARY =========== -->
<A NAME='constant_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
   <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
      <TD>
         <FONT SIZE='+2'><B>Include Statements Summary</B></FONT>
      </TD>
   </TR>
</TABLE>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
   <THEAD>
      <TR><TH>INCLUDE TYPE</TH><TH>INCLUDED FILENAME</TH><TH>DESCRIPTION</TH></TR>
   </THEAD>
   <TBODY>
      <loop name="includes">
      <TR BGCOLOR='white' CLASS='TableRowColor'>
         <TD><A HREF='{page}#{include_file}'>{include_name}</A></TD>
         <TD>{include_value}</TD>
         <TD>{include_sdesc}</TD>
      </TR>
      </loop name="includes">
   </TBODY>
</TABLE>
<br>