|
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 </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.isBuiltin()">{# 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 += "<private> "; |
|
85 if (data.isInner) output += "<inner> "; |
|
86 !} </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 += "<private> "; |
|
115 if (member.isInner) output += "<inner> "; |
|
116 if (member.isStatic) output += "<static> "; |
|
117 if (member.isConstant) output += "<constant> "; |
|
118 !} </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 += "<private> "; |
|
177 if (member.isInner) output += "<inner> "; |
|
178 if (member.isStatic) output += "<static> "; |
|
179 !} </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 <!-- ============================== events summary ======================== --> |
|
220 <if test="data.events.length"> |
|
221 {! var ownEvents = data.events.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} |
|
222 <if test="ownEvents.length"> |
|
223 <table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class {+data.alias+}."> |
|
224 <caption>Event Summary</caption> |
|
225 <thead> |
|
226 <tr> |
|
227 <th scope="col">Event Attributes</th> |
|
228 <th scope="col">Event Name and Description</th> |
|
229 </tr> |
|
230 </thead> |
|
231 <tbody> |
|
232 <for each="member" in="ownEvents"> |
|
233 <tr> |
|
234 <td class="attributes">{! |
|
235 if (member.isPrivate) output += "<private> "; |
|
236 if (member.isInner) output += "<inner> "; |
|
237 if (member.isStatic) output += "<static> "; |
|
238 !} </td> |
|
239 <td class="nameDescription"> |
|
240 <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)+} |
|
241 </div> |
|
242 <div class="description">{+resolveLinks(summarize(member.desc))+}</div> |
|
243 </td> |
|
244 </tr> |
|
245 </for> |
|
246 </tbody> |
|
247 </table> |
|
248 </if> |
|
249 |
|
250 <if test="data.inheritsFrom.length"> |
|
251 <dl class="inheritsList"> |
|
252 {! |
|
253 var borrowedMembers = data.events.filter(function($) {return $.memberOf != data.alias}); |
|
254 var contributers = []; |
|
255 borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); |
|
256 for (var i = 0, l = contributers.length; i < l; i++) { |
|
257 output += |
|
258 "<dt>Events borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>" |
|
259 + |
|
260 "<dd>" + |
|
261 borrowedMembers |
|
262 .filter( |
|
263 function($) { return $.memberOf == contributers[i] } |
|
264 ) |
|
265 .sort(makeSortby("name")) |
|
266 .map( |
|
267 function($) { return new Link().toSymbol($.alias).withText($.name) } |
|
268 ) |
|
269 .join(", ") |
|
270 + |
|
271 "</dd>"; |
|
272 } |
|
273 |
|
274 !} |
|
275 </dl> |
|
276 </if> |
|
277 </if> |
|
278 |
|
279 <!-- ============================== constructor details ==================== --> |
|
280 <if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))"> |
|
281 <div class="details"><a name="constructor"> </a> |
|
282 <div class="sectionTitle"> |
|
283 {+classType+}Detail |
|
284 </div> |
|
285 |
|
286 <div class="fixedFont">{! |
|
287 if (data.isPrivate) output += "<private> "; |
|
288 if (data.isInner) output += "<inner> "; |
|
289 !} |
|
290 <b>{+ data.alias +}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if> |
|
291 </div> |
|
292 |
|
293 <div class="description"> |
|
294 {+resolveLinks(data.desc)+} |
|
295 <if test="data.author"><br /><i>Author: </i>{+data.author+}.</if> |
|
296 </div> |
|
297 |
|
298 <if test="data.example.length"> |
|
299 <for each="example" in="data.example"> |
|
300 <pre class="code">{+example+}</pre> |
|
301 </for> |
|
302 </if> |
|
303 |
|
304 |
|
305 <if test="data.params.length"> |
|
306 <dl class="detailList"> |
|
307 <dt class="heading">Parameters:</dt> |
|
308 <for each="item" in="data.params"> |
|
309 <dt> |
|
310 {+((item.type)?""+("<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type)+"}</span> ")) : "")+} <b>{+item.name+}</b> |
|
311 <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if> |
|
312 </dt> |
|
313 <dd>{+resolveLinks(item.desc)+}</dd> |
|
314 </for> |
|
315 </dl> |
|
316 </if> |
|
317 <if test="data.deprecated"> |
|
318 <dl class="detailList"> |
|
319 <dt class="heading">Deprecated:</dt> |
|
320 <dt> |
|
321 {+resolveLinks(data.deprecated)+} |
|
322 </dt> |
|
323 </dl> |
|
324 </if> |
|
325 <if test="data.since"> |
|
326 <dl class="detailList"> |
|
327 <dt class="heading">Since:</dt> |
|
328 <dd>{+ data.since +}</dd> |
|
329 </dl> |
|
330 </if> |
|
331 <if test="data.exceptions.length"> |
|
332 <dl class="detailList"> |
|
333 <dt class="heading">Throws:</dt> |
|
334 <for each="item" in="data.exceptions"> |
|
335 <dt> |
|
336 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b> |
|
337 </dt> |
|
338 <dd>{+resolveLinks(item.desc)+}</dd> |
|
339 </for> |
|
340 </dl> |
|
341 </if> |
|
342 <if test="data.returns.length"> |
|
343 <dl class="detailList"> |
|
344 <dt class="heading">Returns:</dt> |
|
345 <for each="item" in="data.returns"> |
|
346 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd> |
|
347 </for> |
|
348 </dl> |
|
349 </if> |
|
350 <if test="data.requires.length"> |
|
351 <dl class="detailList"> |
|
352 <dt class="heading">Requires:</dt> |
|
353 <for each="item" in="data.requires"> |
|
354 <dd>{+ resolveLinks(item) +}</dd> |
|
355 </for> |
|
356 </dl> |
|
357 </if> |
|
358 <if test="data.see.length"> |
|
359 <dl class="detailList"> |
|
360 <dt class="heading">See:</dt> |
|
361 <for each="item" in="data.see"> |
|
362 <dd>{+ new Link().toSymbol(item) +}</dd> |
|
363 </for> |
|
364 </dl> |
|
365 </if> |
|
366 |
|
367 </div> |
|
368 </if> |
|
369 |
|
370 <!-- ============================== field details ========================== --> |
|
371 <if test="defined(ownProperties) && ownProperties.length"> |
|
372 <div class="sectionTitle"> |
|
373 Field Detail |
|
374 </div> |
|
375 <for each="member" in="ownProperties"> |
|
376 <a name="{+Link.symbolNameToLinkName(member)+}"> </a> |
|
377 <div class="fixedFont">{! |
|
378 if (member.isPrivate) output += "<private> "; |
|
379 if (member.isInner) output += "<inner> "; |
|
380 if (member.isStatic) output += "<static> "; |
|
381 if (member.isConstant) output += "<constant> "; |
|
382 !} |
|
383 |
|
384 <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if> |
|
385 <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b> |
|
386 |
|
387 </div> |
|
388 <div class="description"> |
|
389 {+resolveLinks(member.desc)+} |
|
390 <if test="member.srcFile != data.srcFile"> |
|
391 <br /> |
|
392 <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}. |
|
393 </if> |
|
394 <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if> |
|
395 </div> |
|
396 |
|
397 <if test="member.example.length"> |
|
398 <for each="example" in="member.example"> |
|
399 <pre class="code">{+example+}</pre> |
|
400 </for> |
|
401 </if> |
|
402 |
|
403 <if test="member.deprecated"> |
|
404 <dl class="detailList"> |
|
405 <dt class="heading">Deprecated:</dt> |
|
406 <dt> |
|
407 {+ resolveLinks(member.deprecated) +} |
|
408 </dt> |
|
409 </dl> |
|
410 </if> |
|
411 <if test="member.since"> |
|
412 <dl class="detailList"> |
|
413 <dt class="heading">Since:</dt> |
|
414 <dd>{+ member.since +}</dd> |
|
415 </dl> |
|
416 </if> |
|
417 <if test="member.see.length"> |
|
418 <dl class="detailList"> |
|
419 <dt class="heading">See:</dt> |
|
420 <for each="item" in="member.see"> |
|
421 <dd>{+ new Link().toSymbol(item) +}</dd> |
|
422 </for> |
|
423 </dl> |
|
424 </if> |
|
425 <if test="member.defaultValue"> |
|
426 <dl class="detailList"> |
|
427 <dt class="heading">Default Value:</dt> |
|
428 <dd> |
|
429 {+resolveLinks(member.defaultValue)+} |
|
430 </dd> |
|
431 </dl> |
|
432 </if> |
|
433 |
|
434 <if test="!$member_last"><hr /></if> |
|
435 </for> |
|
436 </if> |
|
437 |
|
438 <!-- ============================== method details ========================= --> |
|
439 <if test="defined(ownMethods) && ownMethods.length"> |
|
440 <div class="sectionTitle"> |
|
441 Method Detail |
|
442 </div> |
|
443 <for each="member" in="ownMethods"> |
|
444 <a name="{+Link.symbolNameToLinkName(member)+}"> </a> |
|
445 <div class="fixedFont">{! |
|
446 if (member.isPrivate) output += "<private> "; |
|
447 if (member.isInner) output += "<inner> "; |
|
448 if (member.isStatic) output += "<static> "; |
|
449 !} |
|
450 |
|
451 <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if> |
|
452 <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>{+makeSignature(member.params)+} |
|
453 |
|
454 </div> |
|
455 <div class="description"> |
|
456 {+resolveLinks(member.desc)+} |
|
457 <if test="member.srcFile != data.srcFile"> |
|
458 <br /> |
|
459 <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}. |
|
460 </if> |
|
461 <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if> |
|
462 </div> |
|
463 |
|
464 <if test="member.example.length"> |
|
465 <for each="example" in="member.example"> |
|
466 <pre class="code">{+example+}</pre> |
|
467 </for> |
|
468 </if> |
|
469 |
|
470 <if test="member.params.length"> |
|
471 <dl class="detailList"> |
|
472 <dt class="heading">Parameters:</dt> |
|
473 <for each="item" in="member.params"> |
|
474 <dt> |
|
475 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b> |
|
476 <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if> |
|
477 </dt> |
|
478 <dd>{+resolveLinks(item.desc)+}</dd> |
|
479 </for> |
|
480 </dl> |
|
481 </if> |
|
482 <if test="member.deprecated"> |
|
483 <dl class="detailList"> |
|
484 <dt class="heading">Deprecated:</dt> |
|
485 <dt> |
|
486 {+ resolveLinks(member.deprecated) +} |
|
487 </dt> |
|
488 </dl> |
|
489 </if> |
|
490 <if test="member.since"> |
|
491 <dl class="detailList"> |
|
492 <dt class="heading">Since:</dt> |
|
493 <dd>{+ member.since +}</dd> |
|
494 </dl> |
|
495 </dl> |
|
496 </if> |
|
497 <if test="member.exceptions.length"> |
|
498 <dl class="detailList"> |
|
499 <dt class="heading">Throws:</dt> |
|
500 <for each="item" in="member.exceptions"> |
|
501 <dt> |
|
502 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b> |
|
503 </dt> |
|
504 <dd>{+resolveLinks(item.desc)+}</dd> |
|
505 </for> |
|
506 </dl> |
|
507 </if> |
|
508 <if test="member.returns.length"> |
|
509 <dl class="detailList"> |
|
510 <dt class="heading">Returns:</dt> |
|
511 <for each="item" in="member.returns"> |
|
512 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd> |
|
513 </for> |
|
514 </dl> |
|
515 </if> |
|
516 <if test="member.requires.length"> |
|
517 <dl class="detailList"> |
|
518 <dt class="heading">Requires:</dt> |
|
519 <for each="item" in="member.requires"> |
|
520 <dd>{+ resolveLinks(item) +}</dd> |
|
521 </for> |
|
522 </dl> |
|
523 </if> |
|
524 <if test="member.see.length"> |
|
525 <dl class="detailList"> |
|
526 <dt class="heading">See:</dt> |
|
527 <for each="item" in="member.see"> |
|
528 <dd>{+ new Link().toSymbol(item) +}</dd> |
|
529 </for> |
|
530 </dl> |
|
531 </if> |
|
532 |
|
533 <if test="!$member_last"><hr /></if> |
|
534 </for> |
|
535 </if> |
|
536 |
|
537 <!-- ============================== event details ========================= --> |
|
538 <if test="defined(ownEvents) && ownEvents.length"> |
|
539 <div class="sectionTitle"> |
|
540 Event Detail |
|
541 </div> |
|
542 <for each="member" in="ownEvents"> |
|
543 <a name="event:{+Link.symbolNameToLinkName(member)+}"> </a> |
|
544 <div class="fixedFont">{! |
|
545 if (member.isPrivate) output += "<private> "; |
|
546 if (member.isInner) output += "<inner> "; |
|
547 if (member.isStatic) output += "<static> "; |
|
548 !} |
|
549 |
|
550 <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if> |
|
551 <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>{+makeSignature(member.params)+} |
|
552 |
|
553 </div> |
|
554 <div class="description"> |
|
555 {+resolveLinks(member.desc)+} |
|
556 <if test="member.srcFile != data.srcFile"> |
|
557 <br /> |
|
558 <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}. |
|
559 </if> |
|
560 <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if> |
|
561 </div> |
|
562 |
|
563 <if test="member.example.length"> |
|
564 <for each="example" in="member.example"> |
|
565 <pre class="code">{+example+}</pre> |
|
566 </for> |
|
567 </if> |
|
568 |
|
569 <if test="member.params.length"> |
|
570 <dl class="detailList"> |
|
571 <dt class="heading">Parameters:</dt> |
|
572 <for each="item" in="member.params"> |
|
573 <dt> |
|
574 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b> |
|
575 <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if> |
|
576 </dt> |
|
577 <dd>{+ resolveLinks(item.desc) +}</dd> |
|
578 </for> |
|
579 </dl> |
|
580 </if> |
|
581 <if test="member.deprecated"> |
|
582 <dl class="detailList"> |
|
583 <dt class="heading">Deprecated:</dt> |
|
584 <dt> |
|
585 {+ resolveLinks(member.deprecated) +} |
|
586 </dt> |
|
587 </dl> |
|
588 </if> |
|
589 <if test="member.since"> |
|
590 <dl class="detailList"> |
|
591 <dt class="heading">Since:</dt> |
|
592 <dd>{+ member.since +}</dd> |
|
593 </dl> |
|
594 </dl> |
|
595 </if> |
|
596 <if test="member.exceptions.length"> |
|
597 <dl class="detailList"> |
|
598 <dt class="heading">Throws:</dt> |
|
599 <for each="item" in="member.exceptions"> |
|
600 <dt> |
|
601 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b> |
|
602 </dt> |
|
603 <dd>{+ resolveLinks(item.desc) +}</dd> |
|
604 </for> |
|
605 </dl> |
|
606 </if> |
|
607 <if test="member.returns.length"> |
|
608 <dl class="detailList"> |
|
609 <dt class="heading">Returns:</dt> |
|
610 <for each="item" in="member.returns"> |
|
611 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd> |
|
612 </for> |
|
613 </dl> |
|
614 </if> |
|
615 <if test="member.requires.length"> |
|
616 <dl class="detailList"> |
|
617 <dt class="heading">Requires:</dt> |
|
618 <for each="item" in="member.requires"> |
|
619 <dd>{+ resolveLinks(item) +}</dd> |
|
620 </for> |
|
621 </dl> |
|
622 </if> |
|
623 <if test="member.see.length"> |
|
624 <dl class="detailList"> |
|
625 <dt class="heading">See:</dt> |
|
626 <for each="item" in="member.see"> |
|
627 <dd>{+ new Link().toSymbol(item) +}</dd> |
|
628 </for> |
|
629 </dl> |
|
630 </if> |
|
631 |
|
632 <if test="!$member_last"><hr /></if> |
|
633 </for> |
|
634 </if> |
|
635 |
|
636 <hr /> |
|
637 </div> |
|
638 |
|
639 |
|
640 <!-- ============================== footer ================================= --> |
|
641 <div class="fineprint" style="clear:both"> |
|
642 <if test="JSDOC.opt.D.copyright">©{+JSDOC.opt.D.copyright+}<br /></if> |
|
643 Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+} |
|
644 </div> |
|
645 </body> |
|
646 </html> |