vars_summary.inc.html

OPTIONAL template file, included by class.html

Template variables required by this page:

<vars loop>
{page} -- file.ext name of the class documentation page
{var_name} -- name of the variable (with leading $)
{var_sdesc} -- short description of the variable, from its DocBlock
{var_default} -- default value, if present in the definition

Description of class variables, in summary format. Use this optional file in class.html or include the code directly if you desire.

Example:

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

   <loop name="vars">
   <!-- =========== Summary =========== -->
   <TR BGCOLOR='white' CLASS='TableRowColor'>
      <TD>
         <CODE><B><A HREF='{page}#{var_name}'>{var_name}</A></B></CODE>
         <BR>
         <blockquote> {var_sdesc} </blockquote>
         <blockquote> Default Value: <CODE>->{var_default}<-</CODE> </blockquote>
      </TD>
   </TR>
   </loop name="vars">
</TABLE>