mods/phpdoc/PHPDoc/renderer/html/templates/module.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <!-- Generated with PHPDoc, http://www.phpdoc.de -->
   3 <html>
   4 <head>
   5         <title>{APPNAME} - {MODULE_PACKAGE} - Module: {MODULE_NAME}</title>
   6         <link href="phpdoc.css" rel="stylesheet" type="text/css">
   7 </head>
   8
   9 <body>
  10 <table width="100%" border="0">
  11         <tr>
  12                 <td align="left" valign="top" bgcolor="#B0BAFF">
  13                         <table width="100%">
  14                                 <tr>
  15                                         <td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td>
  16                                         <td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td>
  17                                         <td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td>
  18                                         <td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td>
  19                                         <td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td>
  20                                         <td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td>
  21                                 </tr>
  22                         </table>
  23                 </td>
  24         </tr>
  25         <tr>
  26                 <td height="20" align="left" valign="top"><hr></td>
  27         </tr>
  28         <tr>
  29                 <td align="left" valign="top">
  30                         File: <a href="file://{MODULE_FILE}">{MODULE_FILE}</a>
  31                         <h5>{APPNAME} - {MODULE_PACKAGE}</h5>
  32                         <h1>{MODULE_GROUP}::{MODULE_NAME}</h1>
  33                         <p>
  34                         {MODULE_SHORTDESCRIPTION}{MODULE_UNDOC}
  35                         <p>
  36                         &nbsp;
  37                 </td>
  38         </tr>
  39         <tr>
  40                 <td align="left" valign="top">
  41                         <h4>{MODULE_ACCESS} module {MODULE_NAME}</h4>
  42                         {MODULE_SHORTDESCRIPTION}
  43                         <br>
  44                         {MODULE_DESCRIPTION}
  45                         <p>
  46                         <table>
  47                                 <!-- BEGIN module_see --><tr><td align="left" valign="top">See Also</td><td align="left" valign="top">{SEE}</td></tr><!-- END module_see -->
  48                                 <!-- BEGIN module_links --><tr><td align="left" valign="top">Links</td><td align="left" valign="top">{LINK}</td></tr><!-- END module_links -->
  49                                 <!-- BEGIN module_authors --><tr><td align="left" valign="top">Authors</td><td align="left" valign="top">{AUTHOR}</td></tr><!-- END module_authors -->
  50                                 <!-- BEGIN module_since --><tr><td align="left" valign="top">Since</td><td align="left" valign="top">{SINCE}</td></tr><!-- END module_since -->
  51                                 <!-- BEGIN module_version --><tr><td align="left" valign="top">Version</td><td align="left" valign="top">{VERSION}</td></tr><!-- END module_version -->
  52                                 <!-- BEGIN module_deprecated --><tr><td align="left" valign="top">Deprecated</td><td align="left" valign="top">{DEPRECATED}</td></tr><!-- END module_deprecated -->
  53                                 <!-- BEGIN module_copyright --><tr><td align="left" valign="top">Copyright</td><td align="left" valign="top">{COPYRIGHT}</td></tr><!-- END module_copyright -->
  54                                 <!-- BEGIN module_magic --><tr><td align="left" valign="top">Magic</td><td align="left" valign="top">{MAGIC}</td></tr><!-- END module_magic -->
  55                         </table>
  56                 </td>
  57         </tr>
  58         <tr>
  59                 <td height="10" align="left" valign="top">&nbsp;</td>
  60         </tr>
  61         <!-- BEGIN subclasses -->
  62         <tr>
  63                 <td align="left" valign="top">
  64                         <b>Direct known subclasses:</b> {ELEMENTS}
  65                 </td>
  66         </tr>
  67         <!-- END subclasses -->
  68         <tr>
  69                 <td height="20" align="left" valign="top"><hr></td>
  70         </tr>
  71         <!-- BEGIN functionsummary -->
  72         <tr>
  73                 <td align="left" valign="top">
  74                         <table width="100%" border="0">
  75                                 <tr>
  76                                         <td colspan="2" align="left" valign="top"><h2>{ACCESS} Method Summary</h2></td>
  77                                 </tr>
  78                                 <!-- BEGIN functionsummary_loop -->
  79                                 <tr>
  80                                         <td align="right" valign="top">{RETURNTYPE}</td>
  81                                         <td align="left" valign="top" width="100%"><a href="#function_{NAME}()"><h4>{NAME}({PARAMETER})</h4></a>{SHORTDESCRIPTION}{UNDOC}</td>
  82                                 </tr>
  83                                 <!-- END functionsummary_loop -->
  84                         </table>
  85                 </td>
  86         </tr>
  87         <!-- END functionsummary -->
  88         <!-- BEGIN constantssummary -->
  89         <tr>
  90                 <td align="left" valign="top">
  91                         <table width="100%" border="0">
  92                                 <tr>
  93                                         <td align="left" valign="top" colspan=3><h3>{ACCESS} Constant Summary</h3></td>
  94                                 </tr>
  95                                 <!-- BEGIN constantssummary_loop -->
  96                                 <tr>
  97                                         <td align="left" valign="top"><a href="#constants_{NAME}">{NAME}</a></td>
  98                                         <td align="left" valign="top"> >><code>{VALUE}</code><< </td>
  99                                         <td align="left" valign="top" width="100%">{SHORTDESCRIPTION}{UNDOC}</td>
 100                                 </tr>
 101                                 <!-- END constantssummary_loop -->
 102                         </table>
 103                 </td>
 104         </tr>
 105         <!-- END constantssummary -->
 106         <!-- BEGIN usessummary -->
 107         <tr>
 108                 <td align="left" valign="top">
 109                         <table width="100%" border="0">
 110                                 <tr>
 111                                         <td align="left" valign="top" colspan=2><h3>Included files Summary, Type: {TYPE}</h3></td>
 112                                 </tr>
 113                                 <!-- BEGIN usessummary_loop -->
 114                                 <tr>
 115                                         <td align="left" valign="top"><a href="#uses_{FILE}">{FILE}</a></td>
 116                                         <td align="left" valign="top" width="100%"><a href="#uses_{FILE}">{SHORTDESCRIPTION}{UNDOC}</a></td>
 117                                 </tr>
 118                                 <!-- END usessummary_loop -->
 119                         </table>
 120                 </td>
 121         </tr>
 122         <!-- END usessummary -->
 123         <!-- BEGIN functiondetails -->
 124         <tr>
 125                 <td align="left" valign="top">
 126                         <table width="100%" border="0">
 127                                 <tr>
 128                                         <td colspan="2" align="left" valign="top"><h2>{ACCESS} Method Details</h2></td>
 129                                 </tr>
 130                                 <!-- BEGIN functiondetails_loop -->
 131                                 <tr><td colspan="2" align="left" valign="top"><a name="function_{NAME}()"><h4>{NAME}</h4></a></td></tr>
 132                                 <tr>
 133                                         <td colspan="2" align="left" valign="top">
 134                                                 <b>{ACCESS} {ABSTRACT} {STATIC} {FINAL} {RETURNTYPE} {NAME}( {PARAMETER} )</b><p>
 135                                         </td>
 136                                 </tr>
 137                                 <tr>
 138                                         <td width="10" align="left" valign="top">&nbsp;</td>
 139                                         <td align="left" valign="top">
 140                                                 {SHORTDESCRIPTION}
 141                                                 <br>
 142                                                 {DESCRIPTION}
 143                                                 <p>
 144                                                 {UNDOC}
 145                                         </td>
 146                                 </tr>
 147                                 <!-- BEGIN functiondetails_parameter -->
 148                                 <tr>
 149                                         <td colspan="2" align="left" valign="top">Parameter</td>
 150                                 </tr>
 151                                 <!-- BEGIN functiondetails_parameter_loop -->
 152                                 <tr>
 153                                         <td></td>
 154                                         <td align="left" valign="top">
 155                                                 <table>
 156                                                         <tr>
 157                                                                 <td align="left" valign="top">{TYPE}</td>
 158                                                                 <td align="left" valign="top">{NAME}</td>
 159                                                                 <td align="left" valign="top"><code>{DEFAULT}</code></td>
 160                                                         </tr>
 161                                                         <tr>
 162                                                                 <td></td>
 163                                                                 <td colspan="2" align="left" valign="top">{DESCRIPTION}{UNDOC}</td>
 164                                                         </tr>
 165                                                 </table>
 166                                         </td>
 167                                 </tr>
 168                                 <!-- END functiondetails_parameter_loop -->
 169                                 <!-- END functiondetails_parameter -->
 170                                 <!-- BEGIN functiondetails_return -->
 171                                 <tr>
 172                                         <td align="left" valign="top">Returns</td>
 173                                         <td>{TYPE} {NAME}<p>{DESCRIPTION}</td>
 174                                 </tr>
 175                                 <!-- END functiondetails_return -->
 176                                 <!-- BEGIN functiondetails_throws -->
 177                                 <tr>
 178                                         <td align="left" valign="top">Throws</td>
 179                                         <td align="left" valign="top">{EXCEPTIONS}</td>
 180                                 </tr>
 181                                 <!-- END functiondetails_throws -->
 182                                 <!-- BEGIN functiondetails_globals -->
 183                                 <tr>
 184                                         <td colspan="2" align="left" valign="top">Required global variables</td>
 185                                 </tr>
 186                                 <!-- BEGIN functiondetails_globals_loop -->
 187                                 <tr>
 188                                         <td align="left" valign="top"></td>
 189                                         <td align="left" valign="top">
 190                                                 <table>
 191                                                         <tr>
 192                                                                 <td align="left" valign="top">{TYPE} {NAME}</td>
 193                                                                 <td align="left" valign="top">{DESCRIPTION}</td>
 194                                                         </tr>
 195                                                 </table>
 196                                         </td>
 197                                 </tr>
 198                                 <!-- END functiondetails_globals_loop -->
 199                                 <!-- END functiondetails_globals -->
 200                                 <!-- BEGIN functiondetails_version -->
 201                                 <tr>
 202                                         <td align="left" valign="top">Version</td>
 203                                         <td align="left" valign="top">{VERSION}</td>
 204                                 </tr>
 205                                 <!-- END functiondetails_version -->
 206                                 <!-- BEGIN functiondetails_since -->
 207                                 <tr>
 208                                         <td align="left" valign="top">Since</td>
 209                                         <td align="left" valign="top">{SINCE}</td>
 210                                 </tr>
 211                                 <!-- END functiondetails_since -->
 212                                 <!-- BEGIN functiondetails_deprecated -->
 213                                 <tr>
 214                                         <td align="left" valign="top">Deprecated</td>
 215                                         <td align="left" valign="top">{DEPRECATED}</td>
 216                                 </tr>
 217                                 <!-- END functiondetails_deprecated -->
 218                                 <!-- BEGIN functiondetails_copyright -->
 219                                 <tr>
 220                                         <td align="left" valign="top">Copyright</td>
 221                                         <td align="left" valign="top">{COPYRIGHT}</td>
 222                                 </tr>
 223                                 <!-- END functiondetails_copyright -->
 224                                 <!-- BEGIN functiondetails_magic -->
 225                                 <tr>
 226                                         <td align="left" valign="top">Magic</td>
 227                                         <td align="left" valign="top">{MAGIC}</td>
 228                                 </tr>
 229                                 <!-- END functiondetails_magic -->
 230                                 <!-- BEGIN functiondetails_brother -->
 231                                 <tr>
 232                                         <td align="left" valign="top">Brother</td>
 233                                         <td align="left" valign="top">{BROTHER}</td>
 234                                 </tr>
 235                                 <!-- END functiondetails_brother -->
 236                                 <!-- BEGIN functiondetails_see -->
 237                                 <tr>
 238                                         <td align="left" valign="top">See Also</td>
 239                                         <td align="left" valign="top">{SEE}</td>
 240                                 </tr>
 241                                 <!-- END functiondetails_see -->
 242                                 <!-- BEGIN functiondetails_links -->
 243                                 <tr>
 244                                         <td align="left" valign="top">Links</td>
 245                                         <td align="left" valign="top">{LINK}</td>
 246                                 </tr>
 247                                 <!-- END functiondetails_links -->
 248                                 <!-- BEGIN functiondetails_authors -->
 249                                 <tr>
 250                                         <td align="left" valign="top">Author(s)</td>
 251                                         <td align="left" valign="top">{AUTHOR}</td>
 252                                 </tr>
 253                                 <!-- END functiondetails_authors -->
 254                                 <tr>
 255                                         <td colspan="2" align="left" valign="top"><hr></td>
 256                                 </tr>
 257                                 <!-- END functiondetails_loop -->
 258                         </table>
 259         </tr>
 260         <!-- END functiondetails -->
 261         <!-- BEGIN constantdetails -->
 262         <tr>
 263                 <td align="left" valign="top">
 264                         <table width="100%" border="0">
 265                                 <tr>
 266                                         <td colspan="2" align="left" valign="top"><h2>{ACCESS} Constant Details</h2></td>
 267                                 </tr>
 268                                 <!-- BEGIN constantdetails_loop -->
 269                                 <tr>
 270                                         <td colspan="2" align="left" valign="top">
 271                                                 <a name="constant_{NAME}"><h4>{NAME}</h4></a>
 272                                                 <code>define( {NAME}, >>{VALUE}<< )</code><br>
 273                                                 Case: {CASE}
 274                                                 <p>
 275                                                 {SHORTDESCRIPTION}
 276                                                 <br>
 277                                                 {DESCRIPTION}
 278                                         </td>
 279                                 </tr>
 280                                 <!-- BEGIN constantdetails_version -->
 281                                 <tr>
 282                                         <td align="left" valign="top">Version</td>
 283                                         <td align="left" valign="top">{VERSION}</td>
 284                                 </tr>
 285                                 <!-- END constantdetails_version -->
 286                                 <!-- BEGIN constantdetails_since -->
 287                                 <tr>
 288                                         <td align="left" valign="top">Since</td>
 289                                         <td align="left" valign="top">{SINCE}</td>
 290                                 </tr>
 291                                 <!-- END constantdetails_since -->
 292                                 <!-- BEGIN constantdetails_deprecated -->
 293                                 <tr>
 294                                         <td align="left" valign="top">Deprecated</td>
 295                                         <td align="left" valign="top">{DEPRECATED}</td>
 296                                 </tr>
 297                                 <!-- END constantdetails_deprecated -->
 298                                 <!-- BEGIN constantdetails_copyright -->
 299                                 <tr>
 300                                         <td align="left" valign="top">Copyright</td>
 301                                         <td align="left" valign="top">{COPYRIGHT}</td>
 302                                 </tr>
 303                                 <!-- END constantdetails_copyright -->
 304                                 <!-- BEGIN constantdetails_magic -->
 305                                 <tr>
 306                                         <td align="left" valign="top">Magic</td>
 307                                         <td align="left" valign="top">{MAGIC}</td>
 308                                 </tr>
 309                                 <!-- END constantdetails_magic -->
 310                                 <!-- BEGIN constantdetails_brother -->
 311                                 <tr>
 312                                         <td align="left" valign="top">Brother</td>
 313                                         <td align="left" valign="top">{BROTHER}</td>
 314                                 </tr>
 315                                 <!-- END constantdetails_brother -->
 316                                 <!-- BEGIN constantdetails_see -->
 317                                 <tr>
 318                                         <td align="left" valign="top">See Also</td>
 319                                         <td align="left" valign="top">{SEE}</td>
 320                                 </tr>
 321                                 <!-- END constantdetails_see -->
 322                                 <!-- BEGIN constantdetails_links -->
 323                                 <tr>
 324                                         <td align="left" valign="top">Links</td>
 325                                         <td align="left" valign="top">{LINK}</td>
 326                                 </tr>
 327                                 <!-- END constantdetails_links -->
 328                                 <!-- BEGIN constantdetails_authors -->
 329                                 <tr>
 330                                         <td align="left" valign="top">Author(s)</td>
 331                                         <td align="left" valign="top">{AUTHOR}</td>
 332                                 </tr>
 333                                 <!-- END constantdetails_authors -->
 334                                 <tr>
 335                                         <td colspan="2" align="left" valign="top"><hr></td>
 336                                 </tr>
 337                                 <!-- END constantdetails_loop -->
 338                         </table>
 339         </tr>
 340         <!-- END constantdetails -->
 341         <!-- BEGIN usesdetails -->
 342         <tr>
 343                 <td align="left" valign="top">
 344                         <table width="100%" border="0">
 345                                 <tr>
 346                                         <td colspan="2" align="left" valign="top"><h2>Included Files, Type: {TYPE}</h2></td>
 347                                 </tr>
 348                                 <!-- BEGIN usesdetails_loop -->
 349                                 <tr><td colspan="2" align="left" valign="top"><a name="uses_{FILE}"><h4>{FILE}</h4></a></td></tr>
 350                                 <tr>
 351                                         <td colspan="2" align="left" valign="top">
 352                                                 <b>{TYPE}( {FILE} )</b>
 353                                                 <p>
 354                                                 {SHORTDESCRIPTION}
 355                                                 <br>
 356                                                 {DESCRIPTION}
 357                                         </td>
 358                                 </tr>
 359                                 <!-- BEGIN usesdetails_version -->
 360                                 <tr>
 361                                         <td align="left" valign="top">Version</td>
 362                                         <td align="left" valign="top">{VERSION}</td>
 363                                 </tr>
 364                                 <!-- END usesdetails_version -->
 365                                 <!-- BEGIN usesdetails_since -->
 366                                 <tr>
 367                                         <td align="left" valign="top">Since</td>
 368                                         <td align="left" valign="top">{SINCE}</td>
 369                                 </tr>
 370                                 <!-- END usesdetails_since -->
 371                                 <!-- BEGIN usesdetails_deprecated -->
 372                                 <tr>
 373                                         <td align="left" valign="top">Deprecated</td>
 374                                         <td align="left" valign="top">{DEPRECATED}</td>
 375                                 </tr>
 376                                 <!-- END usesdetails_deprecated -->
 377                                 <!-- BEGIN usesdetails_copyright -->
 378                                 <tr>
 379                                         <td align="left" valign="top">Copyright</td>
 380                                         <td align="left" valign="top">{COPYRIGHT}</td>
 381                                 </tr>
 382                                 <!-- END usesdetails_copyright -->
 383                                 <!-- BEGIN usesdetails_magic -->
 384                                 <tr>
 385                                         <td align="left" valign="top">Magic</td>
 386                                         <td align="left" valign="top">{MAGIC}</td>
 387                                 </tr>
 388                                 <!-- END usesdetails_magic -->
 389                                 <!-- BEGIN usesdetails_brother -->
 390                                 <tr>
 391                                         <td align="left" valign="top">Brother</td>
 392                                         <td align="left" valign="top">{BROTHER}</td>
 393                                 </tr>
 394                                 <!-- END usesdetails_brother -->
 395                                 <!-- BEGIN usesdetails_see -->
 396                                 <tr>
 397                                         <td align="left" valign="top">See Also</td>
 398                                         <td align="left" valign="top">{SEE}</td>
 399                                 </tr>
 400                                 <!-- END usesdetails_see -->
 401                                 <!-- BEGIN usesdetails_links -->
 402                                 <tr>
 403                                         <td align="left" valign="top">Links</td>
 404                                         <td align="left" valign="top">{LINK}</td>
 405                                 </tr>
 406                                 <!-- END usesdetails_links -->
 407                                 <!-- BEGIN usesdetails_authors -->
 408                                 <tr>
 409                                         <td align="left" valign="top">Author(s)</td>
 410                                         <td align="left" valign="top">{AUTHOR}</td>
 411                                 </tr>
 412                                 <!-- END usesdetails_authors -->
 413                                 <tr>
 414                                         <td colspan="2" align="left" valign="top"><hr></td>
 415                                 </tr>
 416                                 <!-- END usesdetails_loop -->
 417                         </table>
 418                 </td>
 419         </tr>
 420         <!-- END usesdetails -->
 421         <tr>
 422                 <td height="10" align="left" valign="top"><hr></td>
 423         </tr>
 424         <tr>
 425                 <td align="left" valign="top" bgcolor="#C0C0C0">
 426                         <table width="100%">
 427                                 <tr>
 428                                         <td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td>
 429                                         <td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td>
 430                                         <td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td>
 431                                         <td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td>
 432                                         <td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td>
 433                                         <td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td>
 434                                 </tr>
 435                         </table>
 436                 </td>
 437         </tr>
 438         <tr>
 439                 <td align="left" valign="top">PHPDoc 1.0beta</td>
 440         </tr>
 441 </table>
 442
 443
 444 </body>
 445 </html>