class.html

REQUIRED template file

Template variables required by this page:

{class_name} -- name of the documented class
{class_tree} -- inheritance tree as generated by parserClass::getParentClassTree() and converted to output by HTMLConverter::generateFormattedClassTree()
{children} -- comma-separated list of child classes as generated by parserClass::getChildClassList() and converted to output by HTMLConverter::generateChildClassList()
{source_location} -- relative location of this file from the document root (if parsed by directory) or the filename

From docblock.inc.html:

{sdesc} -- short description of this class from its DocBlock
{desc} -- long description of this class from its DocBlock
<docblock loop> --
{keyword} -- tag name
{data} -- tag information (author name in @author tag, @see link, etc.)

From vars_summary.inc.html:

<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

From vars_inherited.inc.html:

<vars_inherited loop>
{parent_class} -- parent class the variables were inherited from, includes hyperlink generated by parserClass::getInheritedVars() and formatted by HTMLConverter::getFormattedInheritedVars()
<ivars loop>
{ipath} -- file.ext name of class documentation file for parent class
{ivar_name} -- name of the variable (leading $ included)
{default} -- default value from parsed php code
{sdesc} -- short description from the DocBlock

From functions_inherited.inc.html:

<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']))
{sdesc} -- short description from the DocBlock

From functions_summary.inc.html:

{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}

From vars_detail.inc.html:

<var_detail loop>
{var_name} -- name of the class $variable
{var_type} -- data type of the variable, defined with @var tags in the docblock

From docblock.inc.html:

{sdesc} -- short description from DocBlock
{desc} -- long description from DocBlock
<docblock loop> --
{keyword} -- tag name
{data} -- tag information (author name in @author tag, @see link, etc.)

From functions_detail.inc.html

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

The main documentation page for classes, this contains everything you could possibly want to know about a class, as evidenced by the list of variables that the template expects to parse

Example:

<include filename="pagetop.inc.html"/>
<!-- Start of Class Data -->
<H2>
   Class {class_name}
</H2>
<pre>
{class_tree}
</pre>
<H3>
   Classes extended from {class_name}:
</H3>
{children}
<p>
   <b><i>Located in File: {source_location}</i></b><br>
</p>
<hr>
<include filename="docblock.inc.html"/>
<hr>
<include filename="vars_summary.inc.html"/>
<hr>
<include filename="vars_inherited.inc.html"/>
<hr>
<include filename="functions_inherited.inc.html"/>
<br>
<include filename="functions_summary.inc.html"/>
<hbr>
<include filename="vars_detail.inc.html"/>
<hr>
<include filename="functions_detail.inc.html"/>
<hr>
</HTML>