git.roojs.org Git - roojs1/blob - buildSDK/doc_templates/class.tmpl_original

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   4         <head>
   5                 <meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" />
   6                 <meta name="generator" content="JsDoc Toolkit" />
   7                 {! Link.base = "../"; /* all generated links will be relative to this */ !}
   8                 <title>JsDoc Reference - {+data.alias+}</title>
   9
  10                 <style type="text/css">
  11                         {+includeStatic("static/default.css")+}
  12                 </style>
  13         </head>
  14
  15         <body>
  16 <!-- ============================== header ================================= -->
  17                 <!-- begin static/header.html -->
  18                 {+includeStatic("static/header.html")+}
  19                 <!-- end static/header.html -->
  20
  21 <!-- ============================== classes index ============================ -->
  22                 <div id="index">
  23                         <!-- begin publish.classesIndex -->
  24                         {+publish.classesIndex+}
  25                         <!-- end publish.classesIndex -->
  26                 </div>
  27
  28                 <div id="content">
  29 <!-- ============================== class title ============================ -->
  30                         <h1 class="classTitle">
  31                                 {!
  32                                         var classType = "";
  33
  34                                         if (data.isBuiltin()) {
  35                                                 classType += "Built-In ";
  36                                         }
  37
  38                                         if (data.isNamespace) {
  39                                                 if (data.is('FUNCTION')) {
  40                                                         classType += "Function ";
  41                                                 }
  42                                                 classType += "Namespace ";
  43                                         }
  44                                         else {
  45                                                 classType += "Class ";
  46                                         }
  47                                 !}
  48                                 {+classType+}{+data.alias+}
  49                         </h1>
  50
  51 <!-- ============================== class summary ========================== -->
  52                         <p class="description">
  53                                 <if test="data.augments.length"><br />Extends
  54                                         {+
  55                                                 data.augments
  56                                                 .sort()
  57                                                 .map(
  58                                                         function($) { return new Link().toSymbol($); }
  59                                                 )
  60                                                 .join(", ")
  61                                         +}.<br />
  62                                 </if>
  63
  64                                 {+resolveLinks(data.classDesc)+}
  65
  66                                 <if test="data.srcFile.length">{# isn't defined in any file #}
  67                                         <br /><i>Defined in: </i> {+new Link().toSrc(data.srcFile)+}.
  68                                 </if>
  69                         </p>
  70
  71 <!-- ============================== constructor summary ==================== -->
  72                         <if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))">
  73                         <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class {+data.alias+}.">
  74                                 <caption>{+classType+}Summary</caption>
  75                                 <thead>
  76                                         <tr>
  77                                                 <th scope="col">Constructor Attributes</th>
  78                                                 <th scope="col">Constructor Name and Description</th>
  79                                         </tr>
  80                                 </thead>
  81                                 <tbody>
  82                                         <tr>
  83                                                 <td class="attributes">{!
  84                                                         if (data.isPrivate) output += "&lt;private&gt; ";
  85                                                         if (data.isInner) output += "&lt;inner&gt; ";
  86                                                 !}&nbsp;</td>
  87                                                 <td class="nameDescription" {!if (data.comment.getTag("hilited").length){output += 'style="color: red"'}!}>
  88                                                         <div class="fixedFont">
  89                                                                 <b>{+ new Link().toSymbol(data.alias).inner('constructor')+}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if>
  90                                                         </div>
  91                                                         <div class="description">{+resolveLinks(summarize(data.desc))+}</div>
  92                                                 </td>
  93                                         </tr>
  94                                 </tbody>
  95                         </table>
  96                         </if>
  97
  98 <!-- ============================== properties summary ===================== -->
  99                         <if test="data.properties.length">
 100                                 {! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
 101                                 <if test="ownProperties.length">
 102                                 <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class {+data.alias+}.">
 103                                         <caption>Field Summary</caption>
 104                                         <thead>
 105                                                 <tr>
 106                                                         <th scope="col">Field Attributes</th>
 107                                                         <th scope="col">Field Name and Description</th>
 108                                                 </tr>
 109                                         </thead>
 110                                         <tbody>
 111                                         <for each="member" in="ownProperties">
 112                                                 <tr>
 113                                                         <td class="attributes">{!
 114                                                                 if (member.isPrivate) output += "&lt;private&gt; ";
 115                                                                 if (member.isInner) output += "&lt;inner&gt; ";
 116                                                                 if (member.isStatic) output += "&lt;static&gt; ";
 117                                                                 if (member.isConstant) output += "&lt;constant&gt; ";
 118                                                         !}&nbsp;</td>
 119                                                         <td class="nameDescription">
 120                                                                 <div class="fixedFont">
 121                                                                 <if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>
 122                                                                 </div>
 123                                                                 <div class="description">{+resolveLinks(summarize(member.desc))+}</div>
 124                                                         </td>
 125                                                 </tr>
 126                                         </for>
 127                                         </tbody>
 128                                 </table>
 129                                 </if>
 130
 131                                 <if test="data.inheritsFrom.length">
 132                                 <dl class="inheritsList">
 133                                 {!
 134                                         var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias});
 135
 136                                         var contributers = [];
 137                                         borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
 138                                         for (var i = 0, l = contributers.length; i < l; i++) {
 139                                                 output +=
 140                                                         "<dt>Fields borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
 141                                                         +
 142                                                         "<dd>" +
 143                                                         borrowedMembers
 144                                                         .filter(
 145                                                                 function($) { return $.memberOf == contributers[i] }
 146                                                         )
 147                                                         .sort(makeSortby("name"))
 148                                                         .map(
 149                                                                 function($) { return new Link().toSymbol($.alias).withText($.name) }
 150                                                         )
 151                                                         .join(", ")
 152                                                         +
 153                                                         "</dd>";
 154                                         }
 155                                 !}
 156                                 </dl>
 157                                 </if>
 158                         </if>
 159
 160 <!-- ============================== methods summary ======================== -->
 161                         <if test="data.methods.length">
 162                                 {! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias  && !$.isNamespace}).sort(makeSortby("name")); !}
 163                                 <if test="ownMethods.length">
 164                                 <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class {+data.alias+}.">
 165                                         <caption>Method Summary</caption>
 166                                         <thead>
 167                                                 <tr>
 168                                                         <th scope="col">Method Attributes</th>
 169                                                         <th scope="col">Method Name and Description</th>
 170                                                 </tr>
 171                                         </thead>
 172                                         <tbody>
 173                                         <for each="member" in="ownMethods">
 174                                                 <tr>
 175                                                         <td class="attributes">{!
 176                                                                 if (member.isPrivate) output += "&lt;private&gt; ";
 177                                                                 if (member.isInner) output += "&lt;inner&gt; ";
 178                                                                 if (member.isStatic) output += "&lt;static&gt; ";
 179                                                         !}&nbsp;</td>
 180                                                         <td class="nameDescription">
 181                                                                 <div class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>{+makeSignature(member.params)+}
 182                                                                 </div>
 183                                                                 <div class="description">{+resolveLinks(summarize(member.desc))+}</div>
 184                                                         </td>
 185                                                 </tr>
 186                                         </for>
 187                                         </tbody>
 188                                 </table>
 189                                 </if>
 190
 191                                 <if test="data.inheritsFrom.length">
 192                                 <dl class="inheritsList">
 193                                 {!
 194                                         var borrowedMembers = data.methods.filter(function($) {return $.memberOf != data.alias});
 195                                         var contributers = [];
 196                                         borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
 197                                         for (var i = 0, l = contributers.length; i < l; i++) {
 198                                                 output +=
 199                                                         "<dt>Methods borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
 200                                                         +
 201                                                         "<dd>" +
 202                                                         borrowedMembers
 203                                                         .filter(
 204                                                                 function($) { return $.memberOf == contributers[i] }
 205                                                         )
 206                                                         .sort(makeSortby("name"))
 207                                                         .map(
 208                                                                 function($) { return new Link().toSymbol($.alias).withText($.name) }
 209                                                         )
 210                                                         .join(", ")
 211                                                         +
 212                                                         "</dd>";
 213                                         }
 214
 215                                 !}
 216                                 </dl>
 217                                 </if>
 218                         </if>
 219
 220 <!-- ============================== constructor details ==================== -->
 221                         <if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))">
 222                         <div class="details"><a name="constructor"> </a>
 223                                 <div class="sectionTitle">
 224                                         {+classType+}Detail
 225                                 </div>
 226
 227                                 <div class="fixedFont">{!
 228                                         if (data.isPrivate) output += "&lt;private&gt; ";
 229                                         if (data.isInner) output += "&lt;inner&gt; ";
 230                                 !}
 231                                                 <b>{+ data.alias +}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if>
 232                                 </div>
 233
 234                                 <div class="description">
 235                                         {+resolveLinks(data.desc)+}
 236                                         <if test="data.author"><br /><i>Author: </i>{+data.author+}.</if>
 237                                 </div>
 238
 239                                 <if test="data.example">
 240                                 <pre class="code">{+data.example+}</pre>
 241                                 </if>
 242
 243
 244                                         <if test="data.params.length">
 245                                                 <dl class="detailList">
 246                                                 <dt class="heading">Parameters:</dt>
 247                                                 <for each="item" in="data.params">
 248                                                         <dt>
 249                                                                 {+((item.type)?""+("<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type)+"}</span> ")) : "")+} <b>{+item.name+}</b>
 250                                                                 <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
 251                                                         </dt>
 252                                                                 <dd>{+resolveLinks(item.desc)+}</dd>
 253                                                 </for>
 254                                                 </dl>
 255                                         </if>
 256                                         <if test="data.deprecated">
 257                                                 <dl class="detailList">
 258                                                 <dt class="heading">Deprecated:</dt>
 259                                                 <dt>
 260                                                         {+resolveLinks(data.deprecated)+}
 261                                                 </dt>
 262                                                 </dl>
 263                                         </if>
 264                                         <if test="data.since.length">
 265                                                 <dl class="detailList">
 266                                                 <dt class="heading">Since:</dt>
 267                                                 <for each="item" in="data.since">
 268                                                         <dd>{+ item +}</dd>
 269                                                 </for>
 270                                                 </dl>
 271                                         </if>
 272                                         <if test="data.exceptions.length">
 273                                                 <dl class="detailList">
 274                                                 <dt class="heading">Throws:</dt>
 275                                                 <for each="item" in="data.exceptions">
 276                                                         <dt>
 277                                                                 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
 278                                                         </dt>
 279                                                                 <dd>{+resolveLinks(item.desc)+}</dd>
 280                                                 </for>
 281                                                 </dl>
 282                                         </if>
 283                                         <if test="data.returns.length">
 284                                                 <dl class="detailList">
 285                                                 <dt class="heading">Returns:</dt>
 286                                                 <for each="item" in="data.returns">
 287                                                                 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
 288                                                 </for>
 289                                                 </dl>
 290                                         </if>
 291                                         <if test="data.requires.length">
 292                                                 <dl class="detailList">
 293                                                 <dt class="heading">Requires:</dt>
 294                                                 <for each="item" in="data.requires">
 295                                                         <dd>{+ resolveLinks(item) +}</dd>
 296                                                 </for>
 297                                                 </dl>
 298                                         </if>
 299                                         <if test="data.see.length">
 300                                                 <dl class="detailList">
 301                                                 <dt class="heading">See:</dt>
 302                                                 <for each="item" in="data.see">
 303                                                         <dd>{+ new Link().toSymbol(item) +}</dd>
 304                                                 </for>
 305                                                 </dl>
 306                                         </if>
 307
 308                         </div>
 309                         </if>
 310
 311 <!-- ============================== field details ========================== -->
 312                         <if test="isdefined(typeof(ownProperties)) && ownProperties.length">
 313                                 <div class="sectionTitle">
 314                                         Field Detail
 315                                 </div>
 316                                 <for each="member" in="ownProperties">
 317                                         <a name="{+Link.symbolNameToLinkName(member)+}"> </a>
 318                                         <div class="fixedFont">{!
 319                                                 if (member.isPrivate) output += "&lt;private&gt; ";
 320                                                 if (member.isInner) output += "&lt;inner&gt; ";
 321                                                 if (member.isStatic) output += "&lt;static&gt; ";
 322                                                 if (member.isConstant) output += "&lt;constant&gt; ";
 323                                         !}
 324
 325                                         <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
 326                                         <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>
 327
 328                                         </div>
 329                                         <div class="description">
 330                                                 {+resolveLinks(member.desc)+}
 331                                                 <if test="member.srcFile != data.srcFile">
 332                                                         <br />
 333                                                         <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
 334                                                 </if>
 335                                                 <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
 336                                         </div>
 337
 338                                         <if test="member.example">
 339                                         <pre class="code">{+member.example+}</pre>
 340                                         </if>
 341
 342
 343                                                 <if test="member.deprecated">
 344                                                         <dl class="detailList">
 345                                                         <dt class="heading">Deprecated:</dt>
 346                                                         <dt>
 347                                                                 {+ member.deprecated +}
 348                                                         </dt>
 349                                                         </dl>
 350                                                 </if>
 351                                                 <if test="member.since.length">
 352                                                         <dl class="detailList">
 353                                                         <dt class="heading">Since:</dt>
 354                                                                 <dd>{+ member.since +}</dd>
 355                                                         </dl>
 356                                                 </if>
 357                                                 <if test="member.see.length">
 358                                                         <dl class="detailList">
 359                                                         <dt class="heading">See:</dt>
 360                                                         <for each="item" in="member.see">
 361                                                         <dd>{+ new Link().toSymbol(item) +}</dd>
 362                                                         </for>
 363                                                         </dl>
 364                                                 </if>
 365                                                 <if test="member.defaultValue">
 366                                                         <dl class="detailList">
 367                                                         <dt class="heading">Default Value:</dt>
 368                                                         <dd>
 369                                                                 {+resolveLinks(member.defaultValue)+}
 370                                                         </dd>
 371                                                         </dl>
 372                                                 </if>
 373
 374                                         <if test="!$member_last"><hr /></if>
 375                                 </for>
 376                         </if>
 377
 378 <!-- ============================== method details ========================= -->
 379                         <if test="isdefined(typeof(ownMethods)) && ownMethods.length">
 380                                 <div class="sectionTitle">
 381                                         Method Detail
 382                                 </div>
 383                                 <for each="member" in="ownMethods">
 384                                         <a name="{+Link.symbolNameToLinkName(member)+}"> </a>
 385                                         <div class="fixedFont">{!
 386                                                 if (member.isPrivate) output += "&lt;private&gt; ";
 387                                                 if (member.isInner) output += "&lt;inner&gt; ";
 388                                                 if (member.isStatic) output += "&lt;static&gt; ";
 389                                         !}
 390
 391                                         <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
 392                                         <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>{+makeSignature(member.params)+}
 393
 394                                         </div>
 395                                         <div class="description">
 396                                                 {+resolveLinks(member.desc)+}
 397                                                 <if test="member.srcFile != data.srcFile">
 398                                                         <br />
 399                                                         <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
 400                                                 </if>
 401                                                 <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
 402                                         </div>
 403
 404                                         <if test="member.example">
 405                                         <pre class="code">{+member.example+}</pre>
 406                                         </if>
 407
 408
 409                                                 <if test="member.params.length">
 410                                                         <dl class="detailList">
 411                                                         <dt class="heading">Parameters:</dt>
 412                                                         <for each="item" in="member.params">
 413                                                                 <dt>
 414                                                                         {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b>
 415                                                                         <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
 416                                                                 </dt>
 417                                                                 <dd>{+resolveLinks(item.desc)+}</dd>
 418                                                         </for>
 419                                                         </dl>
 420                                                 </if>
 421                                                 <if test="member.deprecated">
 422                                                         <dl class="detailList">
 423                                                         <dt class="heading">Deprecated:</dt>
 424                                                         <dt>
 425                                                                 {+member.deprecated+}
 426                                                         </dt>
 427                                                         </dl>
 428                                                 </if>
 429                                                 <if test="member.since.length">
 430                                                         <dl class="detailList">
 431                                                         <dt class="heading">Since:</dt>
 432                                                                 <dd>{+ member.since +}</dd>
 433                                                         </dl>
 434                                                         </dl>
 435                                                 </if>
 436                                                 <if test="member.exceptions.length">
 437                                                         <dl class="detailList">
 438                                                         <dt class="heading">Throws:</dt>
 439                                                         <for each="item" in="member.exceptions">
 440                                                                 <dt>
 441                                                                         {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
 442                                                                 </dt>
 443                                                                 <dd>{+resolveLinks(item.desc)+}</dd>
 444                                                         </for>
 445                                                         </dl>
 446                                                 </if>
 447                                                 <if test="member.returns.length">
 448                                                         <dl class="detailList">
 449                                                         <dt class="heading">Returns:</dt>
 450                                                         <for each="item" in="member.returns">
 451                                                                 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
 452                                                         </for>
 453                                                         </dl>
 454                                                 </if>
 455                                                 <if test="member.requires.length">
 456                                                         <dl class="detailList">
 457                                                         <dt class="heading">Requires:</dt>
 458                                                         <for each="item" in="member.requires">
 459                                                                 <dd>{+ resolveLinks(item) +}</dd>
 460                                                         </for>
 461                                                         </dl>
 462                                                 </if>
 463                                                 <if test="member.see.length">
 464                                                         <dl class="detailList">
 465                                                         <dt class="heading">See:</dt>
 466                                                         <for each="item" in="member.see">
 467                                                                 <dd>{+ new Link().toSymbol(item) +}</dd>
 468                                                         </for>
 469                                                         </dl>
 470                                                 </if>
 471
 472                                         <if test="!$member_last"><hr /></if>
 473                                 </for>
 474                         </if>
 475
 476                         <hr />
 477                 </div>
 478
 479 <!-- ============================== footer ================================= -->
 480                 <div class="fineprint" style="clear:both">
 481                         <if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
 482                         Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
 483                 </div>
 484         </body>
 485 </html>