page.html

REQUIRED template file

Template variables required by this page:

{source_location} -- relative location of this file from the document root (if parsed by directory) or the filename
{classes} -- comma-separated list of classes found on this page, generated by parserPage::getClasses() and formatted by HTMLConverter::getClassesOnPage()

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 inludes_summary.inc.html:

<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

From globals_summary.inc.html:

<global_summary loop>
{page} -- file.ext name of the file included, use for #a name links
{global_name} -- include/require/include_once/require_once
{global_value} -- file included (same as include_file in 1.0, this may change)

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 constants_summary.inc.html:

<constants loop>
{page} -- file.html name of the current documentation page
{constant_name} -- name of the constant, parsed from the PHP code
{constant_value} -- value of the constant, parsed from the PHP code
{constant_sdesc} -- short description of the constant, parsed from the DocBlock

From functions_summary.inc.html:

{type} -- "Functions" or "Methods"
<functions loop>
{page} -- file.html name of the current documentation 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 includes_detail.inc.html:

<include_detail loop>
{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)

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 globals_detail.inc.html:

<global_detail loop>
{page} -- file.ext name of the file included, use for #a name links
{global_name} -- global variable name
{global_value} -- default value parsed from PHP Code

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 constants_detail.inc.html:

<constant_detail loop>
{constant_name} -- name of the define, parsed from the PHP code
{constant_value} -- value of the define, parsed from the PHP code

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

Procedural Page documentation

Example:

<include filename="pagetop.inc.html"/>
<h2>Page: {source_location}</h2>
<include filename="docblock.inc.html"/>
<br>
Classes defined on this page: {classes}<br>
<include filename="includes_summary.inc.html"/>
<br>
<include filename="globals_summary.inc.html"/>
<br>
<include filename="constants_summary.inc.html"/>
<br>
<include filename="functions_summary.inc.html"/>
<br>
<include filename="includes_detail.inc.html"/>
<br>
<include filename="globals_detail.inc.html"/>
<br>
<include filename="constants_detail.inc.html"/>
<br>
<include filename="functions_detail.inc.html"/>
<br>
</HTML>