Location: PHPKode > projects > PhpScribe Documentation Generator > templates/class.tpl
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
{generated}
<TITLE>
{className} ({projectName})
</TITLE>
<META NAME="keywords" CONTENT="{className} class, {projectName}">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function publishTitle()
{
parent.document.title="{className} class ({projectName})";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="publishTitle();">


<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_overview.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>  
  <!-- START BLOCK : package -->
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../packages/package_{packageName}.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <!-- END BLOCK : package -->
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_index.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../documentation.html"><FONT CLASS="NavBarFont1"><B>Docs</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>{projectName}</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2" COLSPAN="3"><FONT SIZE="-2">
&nbsp;{prevClass}&nbsp;
&nbsp;{nextClass}</FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#nested_class_summary" CLASS="NavBarCell3">NESTED</A>&nbsp;|&nbsp;<A HREF="#constant_summary" CLASS="NavBarCell3">CONSTANT</A>&nbsp;|&nbsp;<A HREF="#field_summary" CLASS="NavBarCell3">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary" CLASS="NavBarCell3">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary" CLASS="NavBarCell3">METHOD</A></FONT></TD>
<TD VALIGN="top"><FONT SIZE="-2">
&nbsp;DETAIL:&nbsp;<A HREF="#constant_detail" CLASS="NavBarCell3">CONSTANT</A>&nbsp;|&nbsp;<A HREF="#field_detail" CLASS="NavBarCell3">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail" CLASS="NavBarCell3">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail" CLASS="NavBarCell3">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<HR>

<H2>
<!-- START BLOCK : package_title -->
<FONT SIZE="-1">
{packageName}</FONT>
<BR>
<!-- END BLOCK : package_title -->
Class {className}</H2>
{objectTree}
<HR>


<DL>
 <DT>public {classStatic}class <B>{className}</B>
 <!-- START BLOCK : extends -->
 <DT>extends {extendClassLink}
 <!-- END BLOCK : extends -->
 <!-- START BLOCK : uses -->
 <DT>uses {useList}
 <!-- END BLOCK : uses -->
 <DT>defined in <B>{classFile}</B> at line <B>{fileLine}</B>
 <!-- START BLOCK : class_author -->
 <DT>written by {classAuthor}
 <!-- END BLOCK : class_author -->
 <!-- START BLOCK : class_notes -->
 <DT>notes
 <!-- START BLOCK : loop_class_notes -->
 <DD>{noteDesc}</DD>
 <!-- END BLOCK : loop_class_notes -->
 <!-- END BLOCK : class_notes -->
</DL>

<P>
{classDesc}
<P>

<P>
<DL>
<!-- START BLOCK : class_since -->
<DT><B>Since:</B></DT>
  <DD>{classSince}</DD>
<!-- END BLOCK : class_since -->
<!-- START BLOCK : class_version -->
<DT><B>Version:</B></DT>
  <DD>{classVersion}</DD>
<!-- END BLOCK : class_version -->  
</DL>
<HR>
<P>

<!-- START BLOCK : nested_classes -->
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TD>
</TR>
<!-- START BLOCK : loop_nested -->
<TR BGCOLOR="white" CLASS="TableRowColor">
 <TD>
  <CODE><B><A HREF="class_{nestedName}.html">{nestedName}</A></B></CODE>
  <DD>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{nestedDesc}
 </TD>
</TR>
<!-- END BLOCK : loop_nested -->
</TABLE>
<P>
<!-- END BLOCK : nested_classes -->

<!-- START BLOCK : constant_summary -->
<!-- =========== CONSTANT SUMMARY =========== -->
<A NAME="constant_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constant Summary</B></FONT></TD>
</TR>
<!-- START BLOCK : loop_constant_summary -->
<TR BGCOLOR="white" CLASS="TableRowColor">
 <TD>
  <CODE><B><A HREF="#constant_{constantName}">{constantName}</A></B></CODE>
  &nbsp;&nbsp;{constantDesc}
 </TD>
</TR>
<!-- END BLOCK : loop_constant_summary -->
</TABLE>
<P>
<!-- END BLOCK : constant_summary -->

<!-- START BLOCK : inherited_constants -->
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  <TD><B>Constants inherited from class <A HREF="class_{inheritedClassName}.html">{inheritedClassName}</A></B></TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
  <TD><CODE>{inheritedList}</CODE></TD>
 </TR>
</TABLE>
<P>
<!-- END BLOCK : inherited_constants -->

<!-- START BLOCK : field_summary -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
<!-- START BLOCK : loop_field_summary -->
<TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%">
  <FONT SIZE="-1"><CODE>{datatype}</CODE></FONT>
 </TD>
 <TD>
  <CODE><B><A HREF="#field_{fieldName}">${fieldName}</A></B></CODE>
  <BR>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{fieldDesc}
 </TD>
</TR>
<!-- END BLOCK : loop_field_summary -->
</TABLE>
<P>
<!-- END BLOCK : field_summary -->

<!-- START BLOCK : inherited_fields -->
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  <TD><B>Fields inherited from class <A HREF="class_{inheritedClassName}.html">{inheritedClassName}</A></B></TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
  <TD><CODE>{inheritedList}</CODE></TD>
 </TR>
</TABLE>
<P>
<!-- START BLOCK : inherited_fields -->

<!-- START BLOCK : constructor_summary -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  <TD COLSPAN=2><FONT SIZE="+2">
   <B>Constructor Summary</B></FONT>
  </TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
  <TD>
   <CODE><B>function <A HREF="#method_{constructorName}">{constructorName}</A></B>({paramList})</CODE>
   <BR>
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{constructorDesc}
  </TD>
 </TR>
</TABLE>
<P>
<!-- END BLOCK : constructor_summary -->

<!-- START BLOCK : method_summary -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  <TD COLSPAN=2>
   <FONT SIZE="+2"><B>Method Summary</B></FONT>
  </TD>
 </TR>
 <!-- START BLOCK : loop_method_summary -->
 <TR BGCOLOR="white" CLASS="TableRowColor">
  <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
   <CODE>&nbsp;{methodStatic}{methodReturnType}</CODE></FONT></TD>
  <TD><CODE><B>{methodRef}<A HREF="#method_{methodName}"">{methodName}</A></B>({paramList})</CODE>
  <BR>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{methodDesc}</TD>
 </TR> 
 <!-- END BLOCK : loop_method_summary -->
</TABLE>
<P>
<!-- END BLOCK : method_summary -->

<!-- START BLOCK : inherited_methods -->
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  <TD>
   <B>Methods inherited from class <A HREF="class_{inheritedClassName}.html">{inheritedClassName}</A></B>
  </TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
  <TD>
   <CODE>{inheritedList}</CODE></TD>
</TR>
</TABLE>
<P>
<!-- END BLOCK : inherited_methods -->

<!-- START BLOCK : constant_detail -->
<A NAME="constant_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  <TD COLSPAN=1><FONT SIZE="+2">
   <B>Constant Detail</B></FONT>
  </TD>
 </TR>
</TABLE>
<!-- START BLOCK : loop_constant_detail -->
<A NAME="constant_{constantName}"><!-- --></A><H3>
{constantName}</H3>
<DL>
<DD>Value: {constantValue}
<DD>{constantDesc}
</DL>
<P>
<HR>
<!-- START BLOCK : loop_constant_detail -->
<P>
<!-- END BLOCK : constant_detail -->

<!-- START BLOCK : field_detail -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  <TD COLSPAN=1><FONT SIZE="+2">
   <B>Field Detail</B></FONT>
  </TD>
 </TR>
</TABLE>
<!-- START BLOCK : loop_field_detail -->
<A NAME="field_{fieldName}"><!-- --></A><H3>
{fieldName}</H3>
<PRE>{datatype}<B>${fieldName}</B></PRE>
<DL>
<DD>{fieldDesc}
<!-- START BLOCK : field_value -->
<DD>Value: {fieldValue}
<!-- END BLOCK : field_value -->
</DL>
<P>
<HR>
<!-- START BLOCK : loop_field_detail -->
<P>
<!-- END BLOCK : field_detail -->

<!-- START BLOCK : constructor_detail -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  <TD COLSPAN=1>
   <FONT SIZE="+2"><B>Constructor Detail</B></FONT>
  </TD>
 </TR>
</TABLE>
<A NAME="method_{constructorName}"><!-- --></A><H3>{constructorName}</H3>
<PRE>
public function <B>{constructorRef}{constructorName}</B>({paramList})</PRE>
<DL>
<DD>{constructorDesc}
<P>


<DD><DL>

<!-- START BLOCK : constructor_params -->
<DT><B>Parameters:</B>
<!-- START BLOCK : loop_constructor_params -->
<DD><CODE>{datatype} {paramRef}${paramName}</CODE> - {paramDesc}{paramDefault}</DD>
<!-- END BLOCK : loop_constructor_params -->
<!-- END BLOCK : constructor_params -->
<!-- START BLOCK : constructor_notes -->
<DT><B>Notes:</B>
<!-- START BLOCK : loop_constructor_notes -->
<DD>{noteDesc}</DD>
<!-- END BLOCK : loop_constructor_notes -->
<!-- END BLOCK : constructor_notes -->
<!-- START BLOCK : constructor_author -->
<DT><B>Written by:</B>
<DD>{constructorAuthor}</DD>
<!-- END BLOCK : constructor_author -->
<!-- START BLOCK : constructor_since -->
<DT><B>Since:</B>
<DD>{constructorSince}</DD>
<!-- END BLOCK : constructor_since -->
<!-- START BLOCK : constructor_version -->
<DT><B>Version:</B>
<DD>{constructorVersion}</DD>
<!-- END BLOCK : constructor_version -->
<DT><B>Definition:</B>
<DD>Defined in {constructorFile} at line {fileLine}
</DL></DD></DL>
<P ALIGN="left"><A HREF="#navbar_top">top</A>
<HR>

<P>
<!-- END BLOCK : constructor_detail -->

<!-- START BLOCK : method_detail -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  <TD COLSPAN=1>
   <FONT SIZE="+2"><B>Method Detail</B></FONT>
  </TD>
 </TR>
</TABLE>
<!-- START BLOCK : loop_method_detail -->
<A NAME="method_{methodName}"><!-- --></A><H3>{methodName}</H3>
<PRE>{access} {methodStatic}function <B>{methodRef}{methodName}</B>({paramList})</PRE>
<DL>
<DD>{methodDesc}
<P>


<DD><DL>
<!-- START BLOCK : method_params -->
<DT><B>Parameters:</B>
<!-- START BLOCK : loop_method_params -->
<DD><CODE>{datatype} {paramRef}${paramName}</CODE> - {paramDesc}{paramDefault}
<!-- END BLOCK : loop_method_params -->
<!-- END BLOCK : method_params -->
<!-- START BLOCK : method_return -->
<DT><B>Returns:</B>
<DD><CODE>{methodReturnType}</CODE>{methodReturn}
<!-- END BLOCK : method_return -->
<!-- START BLOCK : method_see -->
<DT><B>See Also:</B>
<DD>{seeList}
<!-- END BLOCK : method_see -->
<!-- START BLOCK : method_notes -->
<DT><B>Notes:</B>
<!-- START BLOCK : loop_method_notes -->
<DD>{noteDesc}
<!-- END BLOCK : loop_method_notes -->
<!-- END BLOCK : method_notes -->
<!-- START BLOCK : method_author -->
<DT><B>Author:</B>
<DD>{methodAuthor}
<!-- END BLOCK : method_author -->
<!-- START BLOCK : method_since -->
<DT><B>Since:</B>
<DD>{methodSince}
<!-- END BLOCK : method_since -->
<!-- START BLOCK : method_version -->
<DT><B>Version:</B>
<DD>{methodVersion}
<!-- END BLOCK : method_version -->
<DT><B>Definition:</B>
<DD>Defined in {methodFile} at line {fileLine}
<!-- START BLOCK : method_examples -->
<DT><B>Examples and Use Cases:</B>
<!-- START BLOCK : loop_method_examples -->
<DD>{exampleDesc}
<!-- END BLOCK : loop_method_examples -->
<!-- END BLOCK : method_examples -->
<!-- START BLOCK : method_deprecated -->
<DT><B>WARNING! This method is deprecated</B>
<!-- END BLOCK : method_deprecated -->
</DL></DD></DL>
<P ALIGN="left"><A HREF="#navbar_top">top</A>
<HR>
<!-- END BLOCK : loop_method_detail -->
<!-- END BLOCK : method_detail -->

<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_overview.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <!-- START BLOCK : class_package -->
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../packages/package_{packageName}.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <!-- END BLOCK : class_package -->
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_index.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../documentation.html"><FONT CLASS="NavBarFont1"><B>Docs</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>{projectName}</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2" COLSPAN="3"><FONT SIZE="-2">
&nbsp;{prevClass}&nbsp;
&nbsp;{nextClass}</FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#nested_class_summary" CLASS="NavBarCell3">NESTED</A>&nbsp;|&nbsp;<A HREF="#constant_summary" CLASS="NavBarCell3">CONSTANT</A>&nbsp;|&nbsp;<A HREF="#field_summary" CLASS="NavBarCell3">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary" CLASS="NavBarCell3">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary" CLASS="NavBarCell3">METHOD</A></FONT></TD>
<TD VALIGN="top"><FONT SIZE="-2">
&nbsp;DETAIL:&nbsp;<A HREF="#constant_detail" CLASS="NavBarCell3">CONSTANT</A>&nbsp;|&nbsp;<A HREF="#field_detail" CLASS="NavBarCell3">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail" CLASS="NavBarCell3">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail" CLASS="NavBarCell3">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<!-- START BLOCK : bug_submit -->
<font size="-1"><a href="{homePage}">Submit a bug or feature</a></font><br>
<!-- END BLOCK : bug_submit -->
<font size="-1">Copyleft 2002-{year} phpScribe<sup><font size='-2'>TM</font></sup> All rights reserved.
</BODY>
</HTML>
Return current item: PhpScribe Documentation Generator