| 875 |
lars |
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.version"><br />Version
|
|
|
54 |
{+ data.version +}.<br />
|
|
|
55 |
</if>
|
|
|
56 |
<if test="data.augments.length"><br />Extends
|
|
|
57 |
{+
|
|
|
58 |
data.augments
|
|
|
59 |
.sort()
|
|
|
60 |
.map(
|
|
|
61 |
function($) { return new Link().toSymbol($); }
|
|
|
62 |
)
|
|
|
63 |
.join(", ")
|
|
|
64 |
+}.<br />
|
|
|
65 |
</if>
|
|
|
66 |
|
|
|
67 |
{+resolveLinks(data.classDesc)+}
|
|
|
68 |
|
|
|
69 |
<if test="!data.isBuiltin()">{# isn't defined in any file #}
|
|
|
70 |
<br /><i>Defined in: </i> {+new Link().toSrc(data.srcFile)+}.
|
|
|
71 |
</if>
|
|
|
72 |
</p>
|
|
|
73 |
|
|
|
74 |
<!-- ============================== constructor summary ==================== -->
|
|
|
75 |
<if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))">
|
|
|
76 |
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class {+data.alias+}.">
|
|
|
77 |
<caption>{+classType+}Summary</caption>
|
|
|
78 |
<thead>
|
|
|
79 |
<tr>
|
|
|
80 |
<th scope="col">Constructor Attributes</th>
|
|
|
81 |
<th scope="col">Constructor Name and Description</th>
|
|
|
82 |
</tr>
|
|
|
83 |
</thead>
|
|
|
84 |
<tbody>
|
|
|
85 |
<tr>
|
|
|
86 |
<td class="attributes">{!
|
|
|
87 |
if (data.isPrivate) output += "<private> ";
|
|
|
88 |
if (data.isInner) output += "<inner> ";
|
|
|
89 |
!} </td>
|
|
|
90 |
<td class="nameDescription" {!if (data.comment.getTag("hilited").length){output += 'style="color: red"'}!}>
|
|
|
91 |
<div class="fixedFont">
|
|
|
92 |
<b>{+ new Link().toSymbol(data.alias).inner('constructor')+}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if>
|
|
|
93 |
</div>
|
|
|
94 |
<div class="description">{+resolveLinks(summarize(data.desc))+}</div>
|
|
|
95 |
</td>
|
|
|
96 |
</tr>
|
|
|
97 |
</tbody>
|
|
|
98 |
</table>
|
|
|
99 |
</if>
|
|
|
100 |
|
|
|
101 |
<!-- ============================== properties summary ===================== -->
|
|
|
102 |
<if test="data.properties.length">
|
|
|
103 |
{! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
|
|
|
104 |
<if test="ownProperties.length">
|
|
|
105 |
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class {+data.alias+}.">
|
|
|
106 |
<caption>Field Summary</caption>
|
|
|
107 |
<thead>
|
|
|
108 |
<tr>
|
|
|
109 |
<th scope="col">Field Attributes</th>
|
|
|
110 |
<th scope="col">Field Name and Description</th>
|
|
|
111 |
</tr>
|
|
|
112 |
</thead>
|
|
|
113 |
<tbody>
|
|
|
114 |
<for each="member" in="ownProperties">
|
|
|
115 |
<tr>
|
|
|
116 |
<td class="attributes">{!
|
|
|
117 |
if (member.isPrivate) output += "<private> ";
|
|
|
118 |
if (member.isInner) output += "<inner> ";
|
|
|
119 |
if (member.isConstant) output += "<constant> ";
|
|
|
120 |
!} </td>
|
|
|
121 |
<td class="nameDescription">
|
|
|
122 |
<div class="fixedFont">
|
|
|
123 |
<if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>
|
|
|
124 |
</div>
|
|
|
125 |
<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
|
|
|
126 |
</td>
|
|
|
127 |
</tr>
|
|
|
128 |
</for>
|
|
|
129 |
</tbody>
|
|
|
130 |
</table>
|
|
|
131 |
</if>
|
|
|
132 |
|
|
|
133 |
<if test="data.inheritsFrom.length">
|
|
|
134 |
<dl class="inheritsList">
|
|
|
135 |
{!
|
|
|
136 |
var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias});
|
|
|
137 |
|
|
|
138 |
var contributers = [];
|
|
|
139 |
borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
|
|
|
140 |
for (var i = 0, l = contributers.length; i < l; i++) {
|
|
|
141 |
output +=
|
|
|
142 |
"<dt>Fields borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
|
|
|
143 |
+
|
|
|
144 |
"<dd>" +
|
|
|
145 |
borrowedMembers
|
|
|
146 |
.filter(
|
|
|
147 |
function($) { return $.memberOf == contributers[i] }
|
|
|
148 |
)
|
|
|
149 |
.sort(makeSortby("name"))
|
|
|
150 |
.map(
|
|
|
151 |
function($) { return new Link().toSymbol($.alias).withText($.name) }
|
|
|
152 |
)
|
|
|
153 |
.join(", ")
|
|
|
154 |
+
|
|
|
155 |
"</dd>";
|
|
|
156 |
}
|
|
|
157 |
!}
|
|
|
158 |
</dl>
|
|
|
159 |
</if>
|
|
|
160 |
</if>
|
|
|
161 |
|
|
|
162 |
<!-- ============================== methods summary ======================== -->
|
|
|
163 |
<if test="data.methods.length">
|
|
|
164 |
{! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
|
|
|
165 |
<if test="ownMethods.length">
|
|
|
166 |
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class {+data.alias+}.">
|
|
|
167 |
<caption>Method Summary</caption>
|
|
|
168 |
<thead>
|
|
|
169 |
<tr>
|
|
|
170 |
<th scope="col">Method Attributes</th>
|
|
|
171 |
<th scope="col">Method Name and Description</th>
|
|
|
172 |
</tr>
|
|
|
173 |
</thead>
|
|
|
174 |
<tbody>
|
|
|
175 |
<for each="member" in="ownMethods">
|
|
|
176 |
<tr>
|
|
|
177 |
<td class="attributes">{!
|
|
|
178 |
if (member.isPrivate) output += "<private> ";
|
|
|
179 |
if (member.isInner) output += "<inner> ";
|
|
|
180 |
!} </td>
|
|
|
181 |
<td class="nameDescription">
|
|
|
182 |
<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)+}
|
|
|
183 |
</div>
|
|
|
184 |
<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
|
|
|
185 |
</td>
|
|
|
186 |
</tr>
|
|
|
187 |
</for>
|
|
|
188 |
</tbody>
|
|
|
189 |
</table>
|
|
|
190 |
</if>
|
|
|
191 |
|
|
|
192 |
<if test="data.inheritsFrom.length">
|
|
|
193 |
<dl class="inheritsList">
|
|
|
194 |
{!
|
|
|
195 |
var borrowedMembers = data.methods.filter(function($) {return $.memberOf != data.alias});
|
|
|
196 |
var contributers = [];
|
|
|
197 |
borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
|
|
|
198 |
for (var i = 0, l = contributers.length; i < l; i++) {
|
|
|
199 |
output +=
|
|
|
200 |
"<dt>Methods borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
|
|
|
201 |
+
|
|
|
202 |
"<dd>" +
|
|
|
203 |
borrowedMembers
|
|
|
204 |
.filter(
|
|
|
205 |
function($) { return $.memberOf == contributers[i] }
|
|
|
206 |
)
|
|
|
207 |
.sort(makeSortby("name"))
|
|
|
208 |
.map(
|
|
|
209 |
function($) { return new Link().toSymbol($.alias).withText($.name) }
|
|
|
210 |
)
|
|
|
211 |
.join(", ")
|
|
|
212 |
+
|
|
|
213 |
"</dd>";
|
|
|
214 |
}
|
|
|
215 |
|
|
|
216 |
!}
|
|
|
217 |
</dl>
|
|
|
218 |
</if>
|
|
|
219 |
</if>
|
|
|
220 |
<!-- ============================== events summary ======================== -->
|
|
|
221 |
<if test="data.events.length">
|
|
|
222 |
{! var ownEvents = data.events.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
|
|
|
223 |
<if test="ownEvents.length">
|
|
|
224 |
<table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class {+data.alias+}.">
|
|
|
225 |
<caption>Event Summary</caption>
|
|
|
226 |
<thead>
|
|
|
227 |
<tr>
|
|
|
228 |
<th scope="col">Event Attributes</th>
|
|
|
229 |
<th scope="col">Event Name and Description</th>
|
|
|
230 |
</tr>
|
|
|
231 |
</thead>
|
|
|
232 |
<tbody>
|
|
|
233 |
<for each="member" in="ownEvents">
|
|
|
234 |
<tr>
|
|
|
235 |
<td class="attributes">{!
|
|
|
236 |
if (member.isPrivate) output += "<private> ";
|
|
|
237 |
if (member.isInner) output += "<inner> ";
|
|
|
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>{+ new Link().toSymbol(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.isConstant) output += "<constant> ";
|
|
|
381 |
!}
|
|
|
382 |
|
|
|
383 |
<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
|
|
|
384 |
<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>
|
|
|
385 |
|
|
|
386 |
</div>
|
|
|
387 |
<div class="description">
|
|
|
388 |
{+resolveLinks(member.desc)+}
|
|
|
389 |
<if test="member.srcFile != data.srcFile">
|
|
|
390 |
<br />
|
|
|
391 |
<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
|
|
|
392 |
</if>
|
|
|
393 |
<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
|
|
|
394 |
</div>
|
|
|
395 |
|
|
|
396 |
<if test="member.example.length">
|
|
|
397 |
<for each="example" in="member.example">
|
|
|
398 |
<pre class="code">{+example+}</pre>
|
|
|
399 |
</for>
|
|
|
400 |
</if>
|
|
|
401 |
|
|
|
402 |
<if test="member.deprecated">
|
|
|
403 |
<dl class="detailList">
|
|
|
404 |
<dt class="heading">Deprecated:</dt>
|
|
|
405 |
<dt>
|
|
|
406 |
{+ resolveLinks(member.deprecated) +}
|
|
|
407 |
</dt>
|
|
|
408 |
</dl>
|
|
|
409 |
</if>
|
|
|
410 |
<if test="member.since">
|
|
|
411 |
<dl class="detailList">
|
|
|
412 |
<dt class="heading">Since:</dt>
|
|
|
413 |
<dd>{+ member.since +}</dd>
|
|
|
414 |
</dl>
|
|
|
415 |
</if>
|
|
|
416 |
<if test="member.see.length">
|
|
|
417 |
<dl class="detailList">
|
|
|
418 |
<dt class="heading">See:</dt>
|
|
|
419 |
<for each="item" in="member.see">
|
|
|
420 |
<dd>{+ new Link().toSymbol(item) +}</dd>
|
|
|
421 |
</for>
|
|
|
422 |
</dl>
|
|
|
423 |
</if>
|
|
|
424 |
<if test="member.defaultValue">
|
|
|
425 |
<dl class="detailList">
|
|
|
426 |
<dt class="heading">Default Value:</dt>
|
|
|
427 |
<dd>
|
|
|
428 |
{+resolveLinks(member.defaultValue)+}
|
|
|
429 |
</dd>
|
|
|
430 |
</dl>
|
|
|
431 |
</if>
|
|
|
432 |
|
|
|
433 |
<if test="!$member_last"><hr /></if>
|
|
|
434 |
</for>
|
|
|
435 |
</if>
|
|
|
436 |
|
|
|
437 |
<!-- ============================== method details ========================= -->
|
|
|
438 |
<if test="defined(ownMethods) && ownMethods.length">
|
|
|
439 |
<div class="sectionTitle">
|
|
|
440 |
Method Detail
|
|
|
441 |
</div>
|
|
|
442 |
<for each="member" in="ownMethods">
|
|
|
443 |
<a name="{+Link.symbolNameToLinkName(member)+}"> </a>
|
|
|
444 |
<div class="fixedFont">{!
|
|
|
445 |
if (member.isPrivate) output += "<private> ";
|
|
|
446 |
if (member.isInner) output += "<inner> ";
|
|
|
447 |
!}
|
|
|
448 |
|
|
|
449 |
<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
|
|
|
450 |
<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name.replace(/\^\d+$/, '')+}</b>{+makeSignature(member.params)+}
|
|
|
451 |
|
|
|
452 |
</div>
|
|
|
453 |
<div class="description">
|
|
|
454 |
{+resolveLinks(member.desc)+}
|
|
|
455 |
<if test="member.srcFile != data.srcFile">
|
|
|
456 |
<br />
|
|
|
457 |
<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
|
|
|
458 |
</if>
|
|
|
459 |
<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
|
|
|
460 |
</div>
|
|
|
461 |
|
|
|
462 |
<if test="member.example.length">
|
|
|
463 |
<for each="example" in="member.example">
|
|
|
464 |
<pre class="code">{+example+}</pre>
|
|
|
465 |
</for>
|
|
|
466 |
</if>
|
|
|
467 |
|
|
|
468 |
<if test="member.params.length">
|
|
|
469 |
<dl class="detailList">
|
|
|
470 |
<dt class="heading">Parameters:</dt>
|
|
|
471 |
<for each="item" in="member.params">
|
|
|
472 |
<dt>
|
|
|
473 |
{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b>
|
|
|
474 |
<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
|
|
|
475 |
</dt>
|
|
|
476 |
<dd>{+resolveLinks(item.desc)+}</dd>
|
|
|
477 |
</for>
|
|
|
478 |
</dl>
|
|
|
479 |
</if>
|
|
|
480 |
<if test="member.deprecated">
|
|
|
481 |
<dl class="detailList">
|
|
|
482 |
<dt class="heading">Deprecated:</dt>
|
|
|
483 |
<dt>
|
|
|
484 |
{+ resolveLinks(member.deprecated) +}
|
|
|
485 |
</dt>
|
|
|
486 |
</dl>
|
|
|
487 |
</if>
|
|
|
488 |
<if test="member.since">
|
|
|
489 |
<dl class="detailList">
|
|
|
490 |
<dt class="heading">Since:</dt>
|
|
|
491 |
<dd>{+ member.since +}</dd>
|
|
|
492 |
</dl>
|
|
|
493 |
</dl>
|
|
|
494 |
</if>
|
|
|
495 |
<if test="member.exceptions.length">
|
|
|
496 |
<dl class="detailList">
|
|
|
497 |
<dt class="heading">Throws:</dt>
|
|
|
498 |
<for each="item" in="member.exceptions">
|
|
|
499 |
<dt>
|
|
|
500 |
{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
|
|
|
501 |
</dt>
|
|
|
502 |
<dd>{+resolveLinks(item.desc)+}</dd>
|
|
|
503 |
</for>
|
|
|
504 |
</dl>
|
|
|
505 |
</if>
|
|
|
506 |
<if test="member.returns.length">
|
|
|
507 |
<dl class="detailList">
|
|
|
508 |
<dt class="heading">Returns:</dt>
|
|
|
509 |
<for each="item" in="member.returns">
|
|
|
510 |
<dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
|
|
|
511 |
</for>
|
|
|
512 |
</dl>
|
|
|
513 |
</if>
|
|
|
514 |
<if test="member.requires.length">
|
|
|
515 |
<dl class="detailList">
|
|
|
516 |
<dt class="heading">Requires:</dt>
|
|
|
517 |
<for each="item" in="member.requires">
|
|
|
518 |
<dd>{+ resolveLinks(item) +}</dd>
|
|
|
519 |
</for>
|
|
|
520 |
</dl>
|
|
|
521 |
</if>
|
|
|
522 |
<if test="member.see.length">
|
|
|
523 |
<dl class="detailList">
|
|
|
524 |
<dt class="heading">See:</dt>
|
|
|
525 |
<for each="item" in="member.see">
|
|
|
526 |
<dd>{+ new Link().toSymbol(item) +}</dd>
|
|
|
527 |
</for>
|
|
|
528 |
</dl>
|
|
|
529 |
</if>
|
|
|
530 |
|
|
|
531 |
<if test="!$member_last"><hr /></if>
|
|
|
532 |
</for>
|
|
|
533 |
</if>
|
|
|
534 |
|
|
|
535 |
<!-- ============================== event details ========================= -->
|
|
|
536 |
<if test="defined(ownEvents) && ownEvents.length">
|
|
|
537 |
<div class="sectionTitle">
|
|
|
538 |
Event Detail
|
|
|
539 |
</div>
|
|
|
540 |
<for each="member" in="ownEvents">
|
|
|
541 |
<a name="{+Link.symbolNameToLinkName(member)+}"> </a>
|
|
|
542 |
<div class="fixedFont">{!
|
|
|
543 |
if (member.isPrivate) output += "<private> ";
|
|
|
544 |
if (member.isInner) output += "<inner> ";
|
|
|
545 |
!}
|
|
|
546 |
|
|
|
547 |
<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
|
|
|
548 |
<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>{+makeSignature(member.params)+}
|
|
|
549 |
|
|
|
550 |
</div>
|
|
|
551 |
<div class="description">
|
|
|
552 |
{+resolveLinks(member.desc)+}
|
|
|
553 |
<if test="member.srcFile != data.srcFile">
|
|
|
554 |
<br />
|
|
|
555 |
<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
|
|
|
556 |
</if>
|
|
|
557 |
<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
|
|
|
558 |
</div>
|
|
|
559 |
|
|
|
560 |
<if test="member.example.length">
|
|
|
561 |
<for each="example" in="member.example">
|
|
|
562 |
<pre class="code">{+example+}</pre>
|
|
|
563 |
</for>
|
|
|
564 |
</if>
|
|
|
565 |
|
|
|
566 |
<if test="member.params.length">
|
|
|
567 |
<dl class="detailList">
|
|
|
568 |
<dt class="heading">Parameters:</dt>
|
|
|
569 |
<for each="item" in="member.params">
|
|
|
570 |
<dt>
|
|
|
571 |
{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b>
|
|
|
572 |
<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
|
|
|
573 |
</dt>
|
|
|
574 |
<dd>{+ resolveLinks(item.desc) +}</dd>
|
|
|
575 |
</for>
|
|
|
576 |
</dl>
|
|
|
577 |
</if>
|
|
|
578 |
<if test="member.deprecated">
|
|
|
579 |
<dl class="detailList">
|
|
|
580 |
<dt class="heading">Deprecated:</dt>
|
|
|
581 |
<dt>
|
|
|
582 |
{+ resolveLinks(member.deprecated) +}
|
|
|
583 |
</dt>
|
|
|
584 |
</dl>
|
|
|
585 |
</if>
|
|
|
586 |
<if test="member.since">
|
|
|
587 |
<dl class="detailList">
|
|
|
588 |
<dt class="heading">Since:</dt>
|
|
|
589 |
<dd>{+ member.since +}</dd>
|
|
|
590 |
</dl>
|
|
|
591 |
</dl>
|
|
|
592 |
</if>
|
|
|
593 |
<if test="member.exceptions.length">
|
|
|
594 |
<dl class="detailList">
|
|
|
595 |
<dt class="heading">Throws:</dt>
|
|
|
596 |
<for each="item" in="member.exceptions">
|
|
|
597 |
<dt>
|
|
|
598 |
{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
|
|
|
599 |
</dt>
|
|
|
600 |
<dd>{+ resolveLinks(item.desc) +}</dd>
|
|
|
601 |
</for>
|
|
|
602 |
</dl>
|
|
|
603 |
</if>
|
|
|
604 |
<if test="member.returns.length">
|
|
|
605 |
<dl class="detailList">
|
|
|
606 |
<dt class="heading">Returns:</dt>
|
|
|
607 |
<for each="item" in="member.returns">
|
|
|
608 |
<dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
|
|
|
609 |
</for>
|
|
|
610 |
</dl>
|
|
|
611 |
</if>
|
|
|
612 |
<if test="member.requires.length">
|
|
|
613 |
<dl class="detailList">
|
|
|
614 |
<dt class="heading">Requires:</dt>
|
|
|
615 |
<for each="item" in="member.requires">
|
|
|
616 |
<dd>{+ resolveLinks(item) +}</dd>
|
|
|
617 |
</for>
|
|
|
618 |
</dl>
|
|
|
619 |
</if>
|
|
|
620 |
<if test="member.see.length">
|
|
|
621 |
<dl class="detailList">
|
|
|
622 |
<dt class="heading">See:</dt>
|
|
|
623 |
<for each="item" in="member.see">
|
|
|
624 |
<dd>{+ new Link().toSymbol(item) +}</dd>
|
|
|
625 |
</for>
|
|
|
626 |
</dl>
|
|
|
627 |
</if>
|
|
|
628 |
|
|
|
629 |
<if test="!$member_last"><hr /></if>
|
|
|
630 |
</for>
|
|
|
631 |
</if>
|
|
|
632 |
|
|
|
633 |
<hr />
|
|
|
634 |
</div>
|
|
|
635 |
|
|
|
636 |
|
|
|
637 |
<!-- ============================== footer ================================= -->
|
|
|
638 |
<div class="fineprint" style="clear:both">
|
|
|
639 |
<if test="JSDOC.opt.D.copyright">©{+JSDOC.opt.D.copyright+}<br /></if>
|
|
|
640 |
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
|
|
|
641 |
</div>
|
|
|
642 |
</body>
|
|
|
643 |
</html>
|