| 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 |
{+include("static/default.css")+} |
| 12 |
</style> |
| 13 |
</head> |
| 14 |
|
| 15 |
<body> |
| 16 |
<!-- ============================== header ================================= --> |
| 17 |
<!-- begin static/header.html --> |
| 18 |
{+include("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 |
|
| 27 |
<!-- ================== class summary ====================== --> |
| 28 |
|
| 29 |
|
| 30 |
<!-- method list --> |
| 31 |
<if test="data.methods.length"> |
| 32 |
{! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} |
| 33 |
<if test="ownMethods.length"> |
| 34 |
<h2>Methods</h2> |
| 35 |
<ul class="methodList"> |
| 36 |
<for each="member" in="ownMethods"> |
| 37 |
<li><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if>{+new Link().toSymbol(member.alias).withText(member.name.replace(/\^\d+$/, ''))+}</li> |
| 38 |
</for> |
| 39 |
</ul> |
| 40 |
</if> |
| 41 |
</if> |
| 42 |
<!-- end method list --> |
| 43 |
|
| 44 |
<!-- field list --> |
| 45 |
<if test="data.properties.length"> |
| 46 |
{! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} |
| 47 |
<if test="ownProperties.length"> |
| 48 |
<h2>Fields</h2> |
| 49 |
<ul class="propertyList"> |
| 50 |
<for each="member" in="ownProperties"> |
| 51 |
<li><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if>{+new Link().toSymbol(member.alias).withText(member.name)+}</li> |
| 52 |
</for> |
| 53 |
</ul> |
| 54 |
</if> |
| 55 |
</if> |
| 56 |
<!-- end field list --> |
| 57 |
</div> |
| 58 |
|
| 59 |
<div id="content"> |
| 60 |
<!-- ============================== class title ============================ --> |
| 61 |
<h1 class="classTitle"> |
| 62 |
{! |
| 63 |
var classType = ""; |
| 64 |
|
| 65 |
if (data.isBuiltin()) { |
| 66 |
classType += "Built-In "; |
| 67 |
} |
| 68 |
|
| 69 |
if (data.isNamespace) { |
| 70 |
if (data.is('FUNCTION')) { |
| 71 |
classType += "Function "; |
| 72 |
} |
| 73 |
classType += "Namespace "; |
| 74 |
} |
| 75 |
else { |
| 76 |
classType += "Class "; |
| 77 |
} |
| 78 |
!} |
| 79 |
{+classType+}{+data.alias+} |
| 80 |
</h1> |
| 81 |
|
| 82 |
<!-- ============================== class summary ========================== --> |
| 83 |
<p class="description"> |
| 84 |
<if test="data.version"><br />Version |
| 85 |
{+ data.version +}.<br /> |
| 86 |
</if> |
| 87 |
<if test="data.augments.length"><br />Extends |
| 88 |
{+ |
| 89 |
data.augments |
| 90 |
.sort() |
| 91 |
.map( |
| 92 |
function($) { return new Link().toSymbol($); } |
| 93 |
) |
| 94 |
.join(", ") |
| 95 |
+}.<br /> |
| 96 |
</if> |
| 97 |
|
| 98 |
{+resolveLinks(data.classDesc)+} |
| 99 |
|
| 100 |
<if test="!data.isBuiltin()">{# isn't defined in any file #} |
| 101 |
<br /><i>Defined in: </i> {+new Link().toSrc(data.srcFile)+}. |
| 102 |
</if> |
| 103 |
</p> |
| 104 |
|
| 105 |
<!-- ============================== constructor summary ==================== --> |
| 106 |
<if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))"> |
| 107 |
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class {+data.alias+}."> |
| 108 |
<caption>{+classType+}Summary</caption> |
| 109 |
<thead> |
| 110 |
<tr> |
| 111 |
<th scope="col">Constructor Attributes</th> |
| 112 |
<th scope="col">Constructor Name and Description</th> |
| 113 |
</tr> |
| 114 |
</thead> |
| 115 |
<tbody> |
| 116 |
<tr> |
| 117 |
<td class="attributes">{! |
| 118 |
if (data.isPrivate) output += "<private> "; |
| 119 |
if (data.isInner) output += "<inner> "; |
| 120 |
!} </td> |
| 121 |
<td class="nameDescription" {!if (data.comment.getTag("hilited").length){output += 'style="color: red"'}!}> |
| 122 |
<div class="fixedFont"> |
| 123 |
<b>{+ new Link().toSymbol(data.alias).inner('constructor')+}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if> |
| 124 |
</div> |
| 125 |
<div class="description">{+resolveLinks(summarize(data.desc))+}</div> |
| 126 |
</td> |
| 127 |
</tr> |
| 128 |
</tbody> |
| 129 |
</table> |
| 130 |
</if> |
| 131 |
|
| 132 |
<!-- ============================== properties summary ===================== --> |
| 133 |
<if test="data.properties.length"> |
| 134 |
<if test="!defined(ownProperties)"> |
| 135 |
{! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} |
| 136 |
</if> |
| 137 |
<if test="ownProperties.length"> |
| 138 |
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class {+data.alias+}."> |
| 139 |
<caption>Field Summary</caption> |
| 140 |
<thead> |
| 141 |
<tr> |
| 142 |
<th scope="col">Field Attributes</th> |
| 143 |
<th scope="col">Field Name and Description</th> |
| 144 |
</tr> |
| 145 |
</thead> |
| 146 |
<tbody> |
| 147 |
<for each="member" in="ownProperties"> |
| 148 |
<tr> |
| 149 |
<td class="attributes"> |
| 150 |
<if test="member.type"><div class="light">{{+new Link().toSymbol(member.type)+}}</div></if> |
| 151 |
{! |
| 152 |
if (member.isPrivate) output += "<private> "; |
| 153 |
if (member.isInner) output += "<inner> "; |
| 154 |
if (member.isStatic) output += "<static> "; |
| 155 |
if (member.isConstant) output += "<constant> "; |
| 156 |
!} |
| 157 |
</td> |
| 158 |
<td class="nameDescription"> |
| 159 |
<div class="fixedFont"> |
| 160 |
<if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b> |
| 161 |
</div> |
| 162 |
<div class="description">{+resolveLinks(summarize(member.desc))+}</div> |
| 163 |
</td> |
| 164 |
</tr> |
| 165 |
</for> |
| 166 |
</tbody> |
| 167 |
</table> |
| 168 |
</if> |
| 169 |
|
| 170 |
<if test="data.inheritsFrom.length"> |
| 171 |
<dl class="inheritsList"> |
| 172 |
{! |
| 173 |
var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias}); |
| 174 |
|
| 175 |
var contributers = []; |
| 176 |
borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); |
| 177 |
for (var i = 0, l = contributers.length; i < l; i++) { |
| 178 |
output += |
| 179 |
"<dt>Fields borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>" |
| 180 |
+ |
| 181 |
"<dd>" + |
| 182 |
borrowedMembers |
| 183 |
.filter( |
| 184 |
function($) { return $.memberOf == contributers[i] } |
| 185 |
) |
| 186 |
.sort(makeSortby("name")) |
| 187 |
.map( |
| 188 |
function($) { return new Link().toSymbol($.alias).withText($.name) } |
| 189 |
) |
| 190 |
.join(", ") |
| 191 |
+ |
| 192 |
"</dd>"; |
| 193 |
} |
| 194 |
!} |
| 195 |
</dl> |
| 196 |
</if> |
| 197 |
</if> |
| 198 |
|
| 199 |
<!-- ============================== methods summary ======================== --> |
| 200 |
<if test="data.methods.length"> |
| 201 |
<if test="!defined(ownMethods)"> |
| 202 |
{! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} |
| 203 |
</if> |
| 204 |
<if test="ownMethods.length"> |
| 205 |
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class {+data.alias+}."> |
| 206 |
<caption>Method Summary</caption> |
| 207 |
<thead> |
| 208 |
<tr> |
| 209 |
<th scope="col">Method Attributes</th> |
| 210 |
<th scope="col">Method Name and Description</th> |
| 211 |
</tr> |
| 212 |
</thead> |
| 213 |
<tbody> |
| 214 |
<for each="member" in="ownMethods"> |
| 215 |
<tr> |
| 216 |
<td class="attributes"> |
| 217 |
<if test="member.type"><div class="light">{{+new Link().toSymbol(member.type)+}}</div></if> |
| 218 |
{! |
| 219 |
if (member.isPrivate) output += "<private> "; |
| 220 |
if (member.isInner) output += "<inner> "; |
| 221 |
if (member.isStatic) output += "<static> "; |
| 222 |
!} |
| 223 |
</td> |
| 224 |
<td class="nameDescription"> |
| 225 |
<div class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name.replace(/\^\d+$/, ''))+}</b>{+makeSignature(member.params)+} |
| 226 |
</div> |
| 227 |
<div class="description">{+resolveLinks(summarize(member.desc))+}</div> |
| 228 |
</td> |
| 229 |
</tr> |
| 230 |
</for> |
| 231 |
</tbody> |
| 232 |
</table> |
| 233 |
</if> |
| 234 |
|
| 235 |
<if test="data.inheritsFrom.length"> |
| 236 |
<dl class="inheritsList"> |
| 237 |
{! |
| 238 |
var borrowedMembers = data.methods.filter(function($) {return $.memberOf != data.alias}); |
| 239 |
var contributers = []; |
| 240 |
borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); |
| 241 |
for (var i = 0, l = contributers.length; i < l; i++) { |
| 242 |
output += |
| 243 |
"<dt>Methods borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>" |
| 244 |
+ |
| 245 |
"<dd>" + |
| 246 |
borrowedMembers |
| 247 |
.filter( |
| 248 |
function($) { return $.memberOf == contributers[i] } |
| 249 |
) |
| 250 |
.sort(makeSortby("name")) |
| 251 |
.map( |
| 252 |
function($) { return new Link().toSymbol($.alias).withText($.name) } |
| 253 |
) |
| 254 |
.join(", ") |
| 255 |
+ |
| 256 |
"</dd>"; |
| 257 |
} |
| 258 |
|
| 259 |
!} |
| 260 |
</dl> |
| 261 |
</if> |
| 262 |
</if> |
| 263 |
<!-- ============================== events summary ======================== --> |
| 264 |
<if test="data.events.length"> |
| 265 |
{! var ownEvents = data.events.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} |
| 266 |
<if test="ownEvents.length"> |
| 267 |
<table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class {+data.alias+}."> |
| 268 |
<caption>Event Summary</caption> |
| 269 |
<thead> |
| 270 |
<tr> |
| 271 |
<th scope="col">Event Attributes</th> |
| 272 |
<th scope="col">Event Name and Description</th> |
| 273 |
</tr> |
| 274 |
</thead> |
| 275 |
<tbody> |
| 276 |
<for each="member" in="ownEvents"> |
| 277 |
<tr> |
| 278 |
<td class="attributes">{! |
| 279 |
if (member.isPrivate) output += "<private> "; |
| 280 |
if (member.isInner) output += "<inner> "; |
| 281 |
if (member.isStatic) output += "<static> "; |
| 282 |
!} </td> |
| 283 |
<td class="nameDescription"> |
| 284 |
<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)+} |
| 285 |
</div> |
| 286 |
<div class="description">{+resolveLinks(summarize(member.desc))+}</div> |
| 287 |
</td> |
| 288 |
</tr> |
| 289 |
</for> |
| 290 |
</tbody> |
| 291 |
</table> |
| 292 |
</if> |
| 293 |
|
| 294 |
<if test="data.inheritsFrom.length"> |
| 295 |
<dl class="inheritsList"> |
| 296 |
{! |
| 297 |
var borrowedMembers = data.events.filter(function($) {return $.memberOf != data.alias}); |
| 298 |
var contributers = []; |
| 299 |
borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); |
| 300 |
for (var i = 0, l = contributers.length; i < l; i++) { |
| 301 |
output += |
| 302 |
"<dt>Events borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>" |
| 303 |
+ |
| 304 |
"<dd>" + |
| 305 |
borrowedMembers |
| 306 |
.filter( |
| 307 |
function($) { return $.memberOf == contributers[i] } |
| 308 |
) |
| 309 |
.sort(makeSortby("name")) |
| 310 |
.map( |
| 311 |
function($) { return new Link().toSymbol($.alias).withText($.name) } |
| 312 |
) |
| 313 |
.join(", ") |
| 314 |
+ |
| 315 |
"</dd>"; |
| 316 |
} |
| 317 |
|
| 318 |
!} |
| 319 |
</dl> |
| 320 |
</if> |
| 321 |
</if> |
| 322 |
|
| 323 |
<!-- ============================== constructor details ==================== --> |
| 324 |
<if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))"> |
| 325 |
<div class="details"><a name="constructor"> </a> |
| 326 |
<div class="sectionTitle"> |
| 327 |
{+classType+}Detail |
| 328 |
</div> |
| 329 |
|
| 330 |
<div class="fixedFont">{! |
| 331 |
if (data.isPrivate) output += "<private> "; |
| 332 |
if (data.isInner) output += "<inner> "; |
| 333 |
!} |
| 334 |
<b>{+ data.alias +}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if> |
| 335 |
</div> |
| 336 |
|
| 337 |
<div class="description"> |
| 338 |
{+resolveLinks(data.desc)+} |
| 339 |
<if test="data.author"><br /><i>Author: </i>{+data.author+}.</if> |
| 340 |
</div> |
| 341 |
|
| 342 |
<if test="data.example.length"> |
| 343 |
<for each="example" in="data.example"> |
| 344 |
<pre class="code"><code>{+example+}</code></pre> |
| 345 |
</for> |
| 346 |
</if> |
| 347 |
|
| 348 |
|
| 349 |
<if test="data.params.length"> |
| 350 |
<dl class="detailList"> |
| 351 |
<dt class="heading">Parameters:</dt> |
| 352 |
<for each="item" in="data.params"> |
| 353 |
<dt> |
| 354 |
{+((item.type)?""+("<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type)+"}</span> ")) : "")+} <b>{+item.name+}</b> |
| 355 |
<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if> |
| 356 |
</dt> |
| 357 |
<dd>{+resolveLinks(item.desc)+}</dd> |
| 358 |
</for> |
| 359 |
</dl> |
| 360 |
</if> |
| 361 |
<if test="data.deprecated"> |
| 362 |
<dl class="detailList"> |
| 363 |
<dt class="heading">Deprecated:</dt> |
| 364 |
<dt> |
| 365 |
{+resolveLinks(data.deprecated)+} |
| 366 |
</dt> |
| 367 |
</dl> |
| 368 |
</if> |
| 369 |
<if test="data.since"> |
| 370 |
<dl class="detailList"> |
| 371 |
<dt class="heading">Since:</dt> |
| 372 |
<dd>{+ data.since +}</dd> |
| 373 |
</dl> |
| 374 |
</if> |
| 375 |
<if test="data.exceptions.length"> |
| 376 |
<dl class="detailList"> |
| 377 |
<dt class="heading">Throws:</dt> |
| 378 |
<for each="item" in="data.exceptions"> |
| 379 |
<dt> |
| 380 |
{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b> |
| 381 |
</dt> |
| 382 |
<dd>{+resolveLinks(item.desc)+}</dd> |
| 383 |
</for> |
| 384 |
</dl> |
| 385 |
</if> |
| 386 |
<if test="data.returns.length"> |
| 387 |
<dl class="detailList"> |
| 388 |
<dt class="heading">Returns:</dt> |
| 389 |
<for each="item" in="data.returns"> |
| 390 |
<dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd> |
| 391 |
</for> |
| 392 |
</dl> |
| 393 |
</if> |
| 394 |
<if test="data.requires.length"> |
| 395 |
<dl class="detailList"> |
| 396 |
<dt class="heading">Requires:</dt> |
| 397 |
<for each="item" in="data.requires"> |
| 398 |
<dd>{+ new Link().toSymbol(item) +}</dd> |
| 399 |
</for> |
| 400 |
</dl> |
| 401 |
</if> |
| 402 |
<if test="data.see.length"> |
| 403 |
<dl class="detailList"> |
| 404 |
<dt class="heading">See:</dt> |
| 405 |
<for each="item" in="data.see"> |
| 406 |
<dd>{+ new Link().toSymbol(item) +}</dd> |
| 407 |
</for> |
| 408 |
</dl> |
| 409 |
</if> |
| 410 |
|
| 411 |
</div> |
| 412 |
</if> |
| 413 |
|
| 414 |
<!-- ============================== property details ========================== --> |
| 415 |
<if test="defined(ownProperties) && ownProperties.length"> |
| 416 |
<div class="sectionTitle"> |
| 417 |
Field Detail |
| 418 |
</div> |
| 419 |
<for each="member" in="ownProperties"> |
| 420 |
<a name="{+Link.symbolNameToLinkName(member)+}"> </a> |
| 421 |
<div class="fixedFont">{! |
| 422 |
if (member.isPrivate) output += "<private> "; |
| 423 |
if (member.isInner) output += "<inner> "; |
| 424 |
if (member.isStatic) output += "<static> "; |
| 425 |
if (member.isConstant) output += "<constant> "; |
| 426 |
!} |
| 427 |
|
| 428 |
<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if> |
| 429 |
<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b> |
| 430 |
|
| 431 |
</div> |
| 432 |
<div class="description"> |
| 433 |
{+resolveLinks(member.desc)+} |
| 434 |
<if test="member.srcFile != data.srcFile"> |
| 435 |
<br /> |
| 436 |
<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}. |
| 437 |
</if> |
| 438 |
<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if> |
| 439 |
</div> |
| 440 |
|
| 441 |
<if test="member.example.length"> |
| 442 |
<for each="example" in="member.example"> |
| 443 |
<pre class="code"><code>{+example+}</code></pre> |
| 444 |
</for> |
| 445 |
</if> |
| 446 |
|
| 447 |
<if test="member.deprecated"> |
| 448 |
<dl class="detailList"> |
| 449 |
<dt class="heading">Deprecated:</dt> |
| 450 |
<dt> |
| 451 |
{+ resolveLinks(member.deprecated) +} |
| 452 |
</dt> |
| 453 |
</dl> |
| 454 |
</if> |
| 455 |
<if test="member.since"> |
| 456 |
<dl class="detailList"> |
| 457 |
<dt class="heading">Since:</dt> |
| 458 |
<dd>{+ member.since +}</dd> |
| 459 |
</dl> |
| 460 |
</if> |
| 461 |
<if test="member.see.length"> |
| 462 |
<dl class="detailList"> |
| 463 |
<dt class="heading">See:</dt> |
| 464 |
<for each="item" in="member.see"> |
| 465 |
<dd>{+ new Link().toSymbol(item) +}</dd> |
| 466 |
</for> |
| 467 |
</dl> |
| 468 |
</if> |
| 469 |
<if test="member.defaultValue"> |
| 470 |
<dl class="detailList"> |
| 471 |
<dt class="heading">Default Value:</dt> |
| 472 |
<dd> |
| 473 |
{+resolveLinks(member.defaultValue)+} |
| 474 |
</dd> |
| 475 |
</dl> |
| 476 |
</if> |
| 477 |
|
| 478 |
<if test="!$member_last"><hr /></if> |
| 479 |
</for> |
| 480 |
</if> |
| 481 |
|
| 482 |
<!-- ============================== method details ========================= --> |
| 483 |
<if test="defined(ownMethods) && ownMethods.length"> |
| 484 |
<div class="sectionTitle"> |
| 485 |
Method Detail |
| 486 |
</div> |
| 487 |
<for each="member" in="ownMethods"> |
| 488 |
<a name="{+Link.symbolNameToLinkName(member)+}"> </a> |
| 489 |
<div class="fixedFont">{! |
| 490 |
if (member.isPrivate) output += "<private> "; |
| 491 |
if (member.isInner) output += "<inner> "; |
| 492 |
if (member.isStatic) output += "<static> "; |
| 493 |
!} |
| 494 |
|
| 495 |
<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if> |
| 496 |
<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name.replace(/\^\d+$/, '')+}</b>{+makeSignature(member.params)+} |
| 497 |
|
| 498 |
</div> |
| 499 |
<div class="description"> |
| 500 |
{+resolveLinks(member.desc)+} |
| 501 |
<if test="member.srcFile != data.srcFile"> |
| 502 |
<br /> |
| 503 |
<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}. |
| 504 |
</if> |
| 505 |
<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if> |
| 506 |
</div> |
| 507 |
|
| 508 |
<if test="member.example.length"> |
| 509 |
<for each="example" in="member.example"> |
| 510 |
<pre class="code"><code>{+example+}</code></pre> |
| 511 |
</for> |
| 512 |
</if> |
| 513 |
|
| 514 |
<if test="member.params.length"> |
| 515 |
<dl class="detailList"> |
| 516 |
<dt class="heading">Parameters:</dt> |
| 517 |
<for each="item" in="member.params"> |
| 518 |
<dt> |
| 519 |
{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b> |
| 520 |
<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if> |
| 521 |
</dt> |
| 522 |
<dd>{+resolveLinks(item.desc)+}</dd> |
| 523 |
</for> |
| 524 |
</dl> |
| 525 |
</if> |
| 526 |
<if test="member.deprecated"> |
| 527 |
<dl class="detailList"> |
| 528 |
<dt class="heading">Deprecated:</dt> |
| 529 |
<dt> |
| 530 |
{+ resolveLinks(member.deprecated) +} |
| 531 |
</dt> |
| 532 |
</dl> |
| 533 |
</if> |
| 534 |
<if test="member.since"> |
| 535 |
<dl class="detailList"> |
| 536 |
<dt class="heading">Since:</dt> |
| 537 |
<dd>{+ member.since +}</dd> |
| 538 |
</dl> |
| 539 |
</dl> |
| 540 |
</if> |
| 541 |
<if test="member.exceptions.length"> |
| 542 |
<dl class="detailList"> |
| 543 |
<dt class="heading">Throws:</dt> |
| 544 |
<for each="item" in="member.exceptions"> |
| 545 |
<dt> |
| 546 |
{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b> |
| 547 |
</dt> |
| 548 |
<dd>{+resolveLinks(item.desc)+}</dd> |
| 549 |
</for> |
| 550 |
</dl> |
| 551 |
</if> |
| 552 |
<if test="member.returns.length"> |
| 553 |
<dl class="detailList"> |
| 554 |
<dt class="heading">Returns:</dt> |
| 555 |
<for each="item" in="member.returns"> |
| 556 |
<dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd> |
| 557 |
</for> |
| 558 |
</dl> |
| 559 |
</if> |
| 560 |
<if test="member.requires.length"> |
| 561 |
<dl class="detailList"> |
| 562 |
<dt class="heading">Requires:</dt> |
| 563 |
<for each="item" in="member.requires"> |
| 564 |
<dd>{+ resolveLinks(item) +}</dd> |
| 565 |
</for> |
| 566 |
</dl> |
| 567 |
</if> |
| 568 |
<if test="member.see.length"> |
| 569 |
<dl class="detailList"> |
| 570 |
<dt class="heading">See:</dt> |
| 571 |
<for each="item" in="member.see"> |
| 572 |
<dd>{+ new Link().toSymbol(item) +}</dd> |
| 573 |
</for> |
| 574 |
</dl> |
| 575 |
</if> |
| 576 |
|
| 577 |
<if test="!$member_last"><hr /></if> |
| 578 |
</for> |
| 579 |
</if> |
| 580 |
|
| 581 |
<!-- ============================== event details ========================= --> |
| 582 |
<if test="defined(ownEvents) && ownEvents.length"> |
| 583 |
<div class="sectionTitle"> |
| 584 |
Event Detail |
| 585 |
</div> |
| 586 |
<for each="member" in="ownEvents"> |
| 587 |
<a name="{+Link.symbolNameToLinkName(member)+}"> </a> |
| 588 |
<div class="fixedFont">{! |
| 589 |
if (member.isPrivate) output += "<private> "; |
| 590 |
if (member.isInner) output += "<inner> "; |
| 591 |
if (member.isStatic) output += "<static> "; |
| 592 |
!} |
| 593 |
|
| 594 |
<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if> |
| 595 |
<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>{+makeSignature(member.params)+} |
| 596 |
|
| 597 |
</div> |
| 598 |
<div class="description"> |
| 599 |
{+resolveLinks(member.desc)+} |
| 600 |
<if test="member.srcFile != data.srcFile"> |
| 601 |
<br /> |
| 602 |
<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}. |
| 603 |
</if> |
| 604 |
<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if> |
| 605 |
</div> |
| 606 |
|
| 607 |
<if test="member.example.length"> |
| 608 |
<for each="example" in="member.example"> |
| 609 |
<pre class="code"><code>{+example+}</code></pre> |
| 610 |
</for> |
| 611 |
</if> |
| 612 |
|
| 613 |
<if test="member.params.length"> |
| 614 |
<dl class="detailList"> |
| 615 |
<dt class="heading">Parameters:</dt> |
| 616 |
<for each="item" in="member.params"> |
| 617 |
<dt> |
| 618 |
{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b> |
| 619 |
<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if> |
| 620 |
</dt> |
| 621 |
<dd>{+ resolveLinks(item.desc) +}</dd> |
| 622 |
</for> |
| 623 |
</dl> |
| 624 |
</if> |
| 625 |
<if test="member.deprecated"> |
| 626 |
<dl class="detailList"> |
| 627 |
<dt class="heading">Deprecated:</dt> |
| 628 |
<dt> |
| 629 |
{+ resolveLinks(member.deprecated) +} |
| 630 |
</dt> |
| 631 |
</dl> |
| 632 |
</if> |
| 633 |
<if test="member.since"> |
| 634 |
<dl class="detailList"> |
| 635 |
<dt class="heading">Since:</dt> |
| 636 |
<dd>{+ member.since +}</dd> |
| 637 |
</dl> |
| 638 |
</dl> |
| 639 |
</if> |
| 640 |
<if test="member.exceptions.length"> |
| 641 |
<dl class="detailList"> |
| 642 |
<dt class="heading">Throws:</dt> |
| 643 |
<for each="item" in="member.exceptions"> |
| 644 |
<dt> |
| 645 |
{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b> |
| 646 |
</dt> |
| 647 |
<dd>{+ resolveLinks(item.desc) +}</dd> |
| 648 |
</for> |
| 649 |
</dl> |
| 650 |
</if> |
| 651 |
<if test="member.returns.length"> |
| 652 |
<dl class="detailList"> |
| 653 |
<dt class="heading">Returns:</dt> |
| 654 |
<for each="item" in="member.returns"> |
| 655 |
<dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd> |
| 656 |
</for> |
| 657 |
</dl> |
| 658 |
</if> |
| 659 |
<if test="member.requires.length"> |
| 660 |
<dl class="detailList"> |
| 661 |
<dt class="heading">Requires:</dt> |
| 662 |
<for each="item" in="member.requires"> |
| 663 |
<dd>{+ resolveLinks(item) +}</dd> |
| 664 |
</for> |
| 665 |
</dl> |
| 666 |
</if> |
| 667 |
<if test="member.see.length"> |
| 668 |
<dl class="detailList"> |
| 669 |
<dt class="heading">See:</dt> |
| 670 |
<for each="item" in="member.see"> |
| 671 |
<dd>{+ new Link().toSymbol(item) +}</dd> |
| 672 |
</for> |
| 673 |
</dl> |
| 674 |
</if> |
| 675 |
|
| 676 |
<if test="!$member_last"><hr /></if> |
| 677 |
</for> |
| 678 |
</if> |
| 679 |
|
| 680 |
<hr /> |
| 681 |
</div> |
| 682 |
|
| 683 |
|
| 684 |
<!-- ============================== footer ================================= --> |
| 685 |
<div class="fineprint" style="clear:both"> |
| 686 |
<if test="JSDOC.opt.D.copyright">©{+JSDOC.opt.D.copyright+}<br /></if> |
| 687 |
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+} |
| 688 |
</div> |
| 689 |
</body> |
| 690 |
</html> |