docblock.inc.html

OPTIONAL, included by class.html, page.html, vars_detail.inc.html (optional), constants_detail.inc.html (optional), includes_detail.inc.html (optional)

Template variables required by this page:

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

This include file makes things simpler since both class.html and page.html need this information. If you would like different formatting, you can define a different file, or just put the loop right in your primary files.

Example:

<!-- ========== Info from phpDoc block ========= -->
<b>{sdesc}</b>
<pre>
{desc}
</pre>
<UL>
   <loop name="docblock">
   <LI><b>{keyword}</b> - <CODE>{data}</CODE></LI>
   </loop name="docblock">
</UL>