sproutcore 1.0.1035 → 1.0.1037
Sign up to get free protection for your applications and to get access to all the features.
- data/History.txt +5 -1
- data/Rakefile +1 -1
- data/VERSION.yml +2 -2
- data/doc_templates/jsdoc/allclasses.tmpl +17 -0
- data/doc_templates/jsdoc/allfiles.tmpl +56 -0
- data/doc_templates/jsdoc/class.tmpl +487 -0
- data/doc_templates/jsdoc/index.tmpl +38 -0
- data/doc_templates/jsdoc/symbol.tmpl +35 -0
- data/doc_templates/sproutcore/allclasses.tmpl +0 -0
- data/doc_templates/sproutcore/allfiles.tmpl +56 -0
- data/doc_templates/sproutcore/class.tmpl +674 -0
- data/doc_templates/sproutcore/classes-json.tmpl +55 -0
- data/doc_templates/sproutcore/index.tmpl +48 -0
- data/doc_templates/sproutcore/symbol.tmpl +35 -0
- metadata +12 -1
|
@@ -0,0 +1,38 @@
|
|
|
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
|
+
|
|
7
|
+
<title>JsDoc Reference - Index</title>
|
|
8
|
+
<meta name="generator" content="JsDoc Toolkit" />
|
|
9
|
+
|
|
10
|
+
<style type="text/css">
|
|
11
|
+
{+include("static/default.css")+}
|
|
12
|
+
</style>
|
|
13
|
+
</head>
|
|
14
|
+
|
|
15
|
+
<body>
|
|
16
|
+
{+include("static/header.html")+}
|
|
17
|
+
|
|
18
|
+
<div id="index">
|
|
19
|
+
{+publish.classesIndex+}
|
|
20
|
+
</div>
|
|
21
|
+
|
|
22
|
+
<div id="content">
|
|
23
|
+
|
|
24
|
+
<for each="thisClass" in="data">
|
|
25
|
+
<div>
|
|
26
|
+
<h2>{+(new Link().toSymbol(thisClass.alias))+}</h2>
|
|
27
|
+
{+resolveLinks(summarize(thisClass.classDesc))+}
|
|
28
|
+
</div>
|
|
29
|
+
<hr />
|
|
30
|
+
</for>
|
|
31
|
+
|
|
32
|
+
</div>
|
|
33
|
+
<div class="fineprint" style="clear:both">
|
|
34
|
+
<if test="JSDOC.opt.D.copyright">©{+JSDOC.opt.D.copyright+}<br /></if>
|
|
35
|
+
Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
|
|
36
|
+
</div>
|
|
37
|
+
</body>
|
|
38
|
+
</html>
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
<symbol alias="{+data.alias+}">
|
|
2
|
+
<name>{+data.name+}</name>
|
|
3
|
+
<memberOf>{+data.memberOf+}</memberOf>
|
|
4
|
+
<isStatic>{+data.isStatic+}</isStatic>
|
|
5
|
+
<isa>{+data.isa+}</isa>
|
|
6
|
+
<desc>{+data.desc+}</desc>
|
|
7
|
+
<classDesc>{+data.classDesc+}</classDesc>
|
|
8
|
+
|
|
9
|
+
<methods><for each="method" in="data.methods">
|
|
10
|
+
<method>
|
|
11
|
+
<name>{+method.name+}</name>
|
|
12
|
+
<memberOf>{+method.memberOf+}</memberOf>
|
|
13
|
+
<isStatic>{+method.isStatic+}</isStatic>
|
|
14
|
+
<desc>{+method.desc+}</desc>
|
|
15
|
+
<params><for each="param" in="method.params">
|
|
16
|
+
<param>
|
|
17
|
+
<type>{+param.type+}</type>
|
|
18
|
+
<name>{+param.name+}</name>
|
|
19
|
+
<desc>{+param.desc+}</desc>
|
|
20
|
+
<defaultValue>{+param.defaultValue+}</defaultValue>
|
|
21
|
+
</param></for>
|
|
22
|
+
</params>
|
|
23
|
+
</method></for>
|
|
24
|
+
</methods>
|
|
25
|
+
|
|
26
|
+
<properties><for each="property" in="data.properties">
|
|
27
|
+
<property>
|
|
28
|
+
<name>{+property.name+}</name>
|
|
29
|
+
<memberOf>{+property.memberOf+}</memberOf>
|
|
30
|
+
<isStatic>{+property.isStatic+}</isStatic>
|
|
31
|
+
<desc>{+property.desc+}</desc>
|
|
32
|
+
<type>{+property.type+}</type>
|
|
33
|
+
</property></for>
|
|
34
|
+
</properties>
|
|
35
|
+
</symbol>
|
|
File without changes
|
|
@@ -0,0 +1,56 @@
|
|
|
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
|
+
{! Link.base = ""; /* all generated links will be relative to this */ !}
|
|
7
|
+
<title>JsDoc Reference - File Index</title>
|
|
8
|
+
<meta name="generator" content="JsDoc Toolkit" />
|
|
9
|
+
|
|
10
|
+
<style type="text/css">
|
|
11
|
+
{+include("static/default.css")+}
|
|
12
|
+
</style>
|
|
13
|
+
</head>
|
|
14
|
+
|
|
15
|
+
<body>
|
|
16
|
+
{+include("static/header.html")+}
|
|
17
|
+
|
|
18
|
+
<div id="index">
|
|
19
|
+
{+publish.classesIndex+}
|
|
20
|
+
</div>
|
|
21
|
+
|
|
22
|
+
<div id="content">
|
|
23
|
+
<h1 class="classTitle">File Index</h1>
|
|
24
|
+
|
|
25
|
+
<for each="item" in="data">
|
|
26
|
+
<div>
|
|
27
|
+
<h2>{+new Link().toSrc(item.alias).withText(item.name)+}</h2>
|
|
28
|
+
<if test="item.desc">{+resolveLinks(summarize(item.desc))+}</if>
|
|
29
|
+
<dl>
|
|
30
|
+
<if test="item.author">
|
|
31
|
+
<dt class="heading">Author:</dt>
|
|
32
|
+
<dd>{+item.author+}</dd>
|
|
33
|
+
</if>
|
|
34
|
+
<if test="item.version">
|
|
35
|
+
<dt class="heading">Version:</dt>
|
|
36
|
+
<dd>{+item.version+}</dd>
|
|
37
|
+
</if>
|
|
38
|
+
{! var locations = item.comment.getTag('location').map(function($){return $.toString().replace(/(^\$ ?| ?\$$)/g, '').replace(/^HeadURL: https:/g, 'http:');}) !}
|
|
39
|
+
<if test="locations.length">
|
|
40
|
+
<dt class="heading">Location:</dt>
|
|
41
|
+
<for each="location" in="locations">
|
|
42
|
+
<dd><a href="{+location+}">{+location+}</a></dd>
|
|
43
|
+
</for>
|
|
44
|
+
</if>
|
|
45
|
+
</dl>
|
|
46
|
+
</div>
|
|
47
|
+
<hr />
|
|
48
|
+
</for>
|
|
49
|
+
|
|
50
|
+
</div>
|
|
51
|
+
<div class="fineprint" style="clear:both">
|
|
52
|
+
<if test="JSDOC.opt.D.copyright">©{+JSDOC.opt.D.copyright+}<br /></if>
|
|
53
|
+
Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
|
|
54
|
+
</div>
|
|
55
|
+
</body>
|
|
56
|
+
</html>
|
|
@@ -0,0 +1,674 @@
|
|
|
1
|
+
{!
|
|
2
|
+
rowClass = 'even';
|
|
3
|
+
function resetRowClass() { rowClass = 'even'; };
|
|
4
|
+
|
|
5
|
+
function nextRowClass() {
|
|
6
|
+
var ret = rowClass ;
|
|
7
|
+
rowClass = (rowClass == 'even') ? 'odd' : 'even' ;
|
|
8
|
+
return ret ;
|
|
9
|
+
} ;
|
|
10
|
+
|
|
11
|
+
function summarize(desc) {
|
|
12
|
+
if (typeof desc != "undefined")
|
|
13
|
+
return desc.match(/([\w\W]+?\.)[^a-z0-9]/i)? RegExp.$1 : desc;
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
function htmlize(desc, stripSummary) {
|
|
17
|
+
if (stripSummary === undefined) stripSummary = true;
|
|
18
|
+
if (stripSummary) {
|
|
19
|
+
var summary = summarize(desc);
|
|
20
|
+
desc = (summary && summary.length > 0) ? desc.slice(summary.length, desc.length) : desc ;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
return superTextile(desc);
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
function constantText(p) {
|
|
27
|
+
return '<code><span class="type">' + (p.type||"Object") + '</span>' + ' <span class="name">' + p.name + '</span></code>' ;
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
function propertyText(p) {
|
|
31
|
+
var ret = '';
|
|
32
|
+
|
|
33
|
+
ret += (p.isStatic || !p.memberOf) ? '+' : '-' ;
|
|
34
|
+
ret += ' (';
|
|
35
|
+
ret += (p.isPrivate) ? 'private ' : '';
|
|
36
|
+
ret += p.type || 'Object' ;
|
|
37
|
+
ret += ') ' + p.name ;
|
|
38
|
+
|
|
39
|
+
if(p.isReadOnly)
|
|
40
|
+
{
|
|
41
|
+
ret += ' [R/O]';
|
|
42
|
+
}
|
|
43
|
+
else
|
|
44
|
+
{
|
|
45
|
+
ret += ' [R/W]';
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
return '<code>' + ret + '</code>' ;
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
function isUsefulParam(param) {
|
|
52
|
+
if (!param) return false ;
|
|
53
|
+
if (param.type && param.type.length > 0) return true ;
|
|
54
|
+
if (param.desc && param.desc.length > 0) return true ;
|
|
55
|
+
return false ;
|
|
56
|
+
} ;
|
|
57
|
+
|
|
58
|
+
function hasUsefulParams(params) {
|
|
59
|
+
if (!params || !params.length) return false ;
|
|
60
|
+
var idx = params.length;
|
|
61
|
+
while(--idx >= 0) {
|
|
62
|
+
var param = params[idx] ;
|
|
63
|
+
if (isUsefulParam(param)) return true ;
|
|
64
|
+
}
|
|
65
|
+
return false ;
|
|
66
|
+
};
|
|
67
|
+
|
|
68
|
+
function relativeSrcPath(path) {
|
|
69
|
+
var parts = path.split('/') ;
|
|
70
|
+
|
|
71
|
+
var rootIndex = parts.indexOf('frameworks') ;
|
|
72
|
+
if (rootIndex < 0) rootIndex = parts.indexOf('clients') ;
|
|
73
|
+
|
|
74
|
+
if (rootIndex < 0) {
|
|
75
|
+
return parts[parts.length - 2] ;
|
|
76
|
+
|
|
77
|
+
} else {
|
|
78
|
+
return parts.slice(rootIndex, parts.length).join('/') ;
|
|
79
|
+
}
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
!}
|
|
83
|
+
|
|
84
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
85
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
86
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
87
|
+
<head>
|
|
88
|
+
<meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" />
|
|
89
|
+
<meta name="generator" content="JsDoc Toolkit" />
|
|
90
|
+
{! Link.base = "../"; /* all generated links will be relative to this */ !}
|
|
91
|
+
<title>JsDoc Reference - {+data.alias+}</title>
|
|
92
|
+
|
|
93
|
+
<style type="text/css">
|
|
94
|
+
{+include("static/default.css")+}
|
|
95
|
+
</style>
|
|
96
|
+
</head>
|
|
97
|
+
|
|
98
|
+
<body class="sc-doc">
|
|
99
|
+
|
|
100
|
+
<div id="content">
|
|
101
|
+
|
|
102
|
+
<h1>
|
|
103
|
+
{!
|
|
104
|
+
var classType = "";
|
|
105
|
+
|
|
106
|
+
if (data.isBuiltin()) {
|
|
107
|
+
classType += "Built-In ";
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
if (data.isNamespace) {
|
|
111
|
+
if (data.is('FUNCTION')) {
|
|
112
|
+
classType += "Function ";
|
|
113
|
+
}
|
|
114
|
+
classType += "Namespace ";
|
|
115
|
+
}
|
|
116
|
+
else {
|
|
117
|
+
classType += "Class ";
|
|
118
|
+
}
|
|
119
|
+
!}
|
|
120
|
+
{+classType+}{+data.alias+}
|
|
121
|
+
</h1>
|
|
122
|
+
|
|
123
|
+
<table class="summary">
|
|
124
|
+
{! resetRowClass(); !}
|
|
125
|
+
|
|
126
|
+
<if test="data.deprecated">
|
|
127
|
+
<tr class="{+ nextRowClass() +}">
|
|
128
|
+
<td class="label">Deprecated:</td>
|
|
129
|
+
<td class="value">
|
|
130
|
+
{+htmlize(thisClass.deprecated.desc)+}
|
|
131
|
+
</td>
|
|
132
|
+
</tr>
|
|
133
|
+
</if>
|
|
134
|
+
|
|
135
|
+
<if test="data.augments.length">
|
|
136
|
+
<tr class="{+ nextRowClass() +}">
|
|
137
|
+
<td class="label">Extends:</td>
|
|
138
|
+
<td class="value">
|
|
139
|
+
{+
|
|
140
|
+
data.augments
|
|
141
|
+
.sort()
|
|
142
|
+
.map(
|
|
143
|
+
function($) { return new Link().toSymbol($); }
|
|
144
|
+
)
|
|
145
|
+
.join(", ")
|
|
146
|
+
+}
|
|
147
|
+
</td>
|
|
148
|
+
</tr>
|
|
149
|
+
</if>
|
|
150
|
+
|
|
151
|
+
<if test="!data.isBuiltin()">
|
|
152
|
+
<tr class="{+ nextRowClass() +}">
|
|
153
|
+
<td class="label">Defined in:</td>
|
|
154
|
+
<td class="value">{+new Link().toSrc(data.srcFile).withText(relativeSrcPath(data.srcFile))+}</td>
|
|
155
|
+
</tr>
|
|
156
|
+
</if>
|
|
157
|
+
|
|
158
|
+
<if test="data.since">
|
|
159
|
+
<tr class="{+ nextRowClass() +}">
|
|
160
|
+
<td class="label">Availability:</td>
|
|
161
|
+
<td class="value">
|
|
162
|
+
since {+data.since+}
|
|
163
|
+
</td>
|
|
164
|
+
</tr>
|
|
165
|
+
</if>
|
|
166
|
+
|
|
167
|
+
<if test="data.version">
|
|
168
|
+
<tr class="{+ nextRowClass() +}">
|
|
169
|
+
<td class="label">Version:</td>
|
|
170
|
+
<td class="value">{+data.version+}</td>
|
|
171
|
+
</tr>
|
|
172
|
+
</if>
|
|
173
|
+
|
|
174
|
+
<if test="data.author">
|
|
175
|
+
<tr class="{+ nextRowClass() +}">
|
|
176
|
+
<td class="label">Author:</td>
|
|
177
|
+
<td class="value">{+data.author+}</td>
|
|
178
|
+
</tr>
|
|
179
|
+
</if>
|
|
180
|
+
|
|
181
|
+
<if test="data.copyright">
|
|
182
|
+
<tr class="{+ nextRowClass() +}">
|
|
183
|
+
<td class="label">Copyright:</td>
|
|
184
|
+
<td class="value">{+data.copyright+}</td>
|
|
185
|
+
</tr>
|
|
186
|
+
</if>
|
|
187
|
+
|
|
188
|
+
</table>
|
|
189
|
+
|
|
190
|
+
<if test="data.classDesc">
|
|
191
|
+
<h2>
|
|
192
|
+
Overview
|
|
193
|
+
</h2>
|
|
194
|
+
<div class="description">
|
|
195
|
+
{+htmlize(data.classDesc, false)+}
|
|
196
|
+
</div>
|
|
197
|
+
</if>
|
|
198
|
+
|
|
199
|
+
<!-- ============================== properties summary ===================== -->
|
|
200
|
+
<if test="data.properties.length">
|
|
201
|
+
{!
|
|
202
|
+
var allProps = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("commonTask"));
|
|
203
|
+
|
|
204
|
+
var commonTasks = {};
|
|
205
|
+
var uncommonTasks = [];
|
|
206
|
+
var currentKey = '';
|
|
207
|
+
var commonLen = 0;
|
|
208
|
+
for(var k=0; k<allProps.length; k++)
|
|
209
|
+
{
|
|
210
|
+
if(!allProps[k].commonTask)
|
|
211
|
+
{
|
|
212
|
+
uncommonTasks.push(allProps[k]);
|
|
213
|
+
continue;
|
|
214
|
+
}
|
|
215
|
+
if(allProps[k].commonTask != currentKey)
|
|
216
|
+
{
|
|
217
|
+
currentKey = allProps[k].commonTask;
|
|
218
|
+
commonTasks[currentKey] = [];
|
|
219
|
+
commonLen++;
|
|
220
|
+
}
|
|
221
|
+
commonTasks[currentKey].push(allProps[k]);
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
var ownConstants = allProps.filter(function($){return $.isConstant}).sort(makeSortby("name"));
|
|
225
|
+
uncommonTasks.sort(makeSortby("name"));
|
|
226
|
+
|
|
227
|
+
allProps.sort(makeSortby("name"));
|
|
228
|
+
!}
|
|
229
|
+
|
|
230
|
+
<if test="ownConstants.length">
|
|
231
|
+
<div class="field-summary summary">
|
|
232
|
+
<h2>Constants</h2>
|
|
233
|
+
<ul>
|
|
234
|
+
<for each="member" in="ownConstants">
|
|
235
|
+
<li>
|
|
236
|
+
{+new Link().toSymbol(member.alias).withText(constantText(member))+}
|
|
237
|
+
<if test="member.desc">
|
|
238
|
+
<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
|
|
239
|
+
</if>
|
|
240
|
+
</li>
|
|
241
|
+
</for>
|
|
242
|
+
</ul>
|
|
243
|
+
</div>
|
|
244
|
+
</if>
|
|
245
|
+
|
|
246
|
+
{!
|
|
247
|
+
if(commonLen > 0)
|
|
248
|
+
{
|
|
249
|
+
|
|
250
|
+
!}
|
|
251
|
+
|
|
252
|
+
<if test="uncommonTasks.length">
|
|
253
|
+
<div class="field-summary summary">
|
|
254
|
+
<h2>General Property Summary</h2>
|
|
255
|
+
<ul>
|
|
256
|
+
<for each="member" in="uncommonTasks">
|
|
257
|
+
<if test="!(member.isConstant)">
|
|
258
|
+
<li>
|
|
259
|
+
{+new Link().toSymbol(member.alias).withText(propertyText(member))+}
|
|
260
|
+
<if test="member.desc">
|
|
261
|
+
<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
|
|
262
|
+
</if>
|
|
263
|
+
</li>
|
|
264
|
+
</if>
|
|
265
|
+
</for>
|
|
266
|
+
</ul>
|
|
267
|
+
</div>
|
|
268
|
+
</if>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
{!
|
|
272
|
+
for(var key in commonTasks)
|
|
273
|
+
{
|
|
274
|
+
commonTasks[key].sort(makeSortby("name"));
|
|
275
|
+
var props = commonTasks[key];
|
|
276
|
+
!}
|
|
277
|
+
|
|
278
|
+
<div class="field-summary summary">
|
|
279
|
+
<h2>Common Properties For '{! output+=key; !}'</h2>
|
|
280
|
+
<ul>
|
|
281
|
+
<for each="member" in="props">
|
|
282
|
+
<if test="!(member.isConstant)">
|
|
283
|
+
<li>
|
|
284
|
+
{+new Link().toSymbol(member.alias).withText(propertyText(member))+}
|
|
285
|
+
<if test="member.desc">
|
|
286
|
+
<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
|
|
287
|
+
</if>
|
|
288
|
+
</li>
|
|
289
|
+
</if>
|
|
290
|
+
</for>
|
|
291
|
+
</ul>
|
|
292
|
+
</div>
|
|
293
|
+
|
|
294
|
+
{!
|
|
295
|
+
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
else
|
|
299
|
+
{
|
|
300
|
+
|
|
301
|
+
!}
|
|
302
|
+
|
|
303
|
+
<if test="uncommonTasks.length">
|
|
304
|
+
<div class="field-summary summary">
|
|
305
|
+
<h2>Property Summary</h2>
|
|
306
|
+
<ul>
|
|
307
|
+
<for each="member" in="uncommonTasks">
|
|
308
|
+
<if test="!(member.isConstant)">
|
|
309
|
+
<li>
|
|
310
|
+
{+new Link().toSymbol(member.alias).withText(propertyText(member))+}
|
|
311
|
+
<if test="member.desc">
|
|
312
|
+
<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
|
|
313
|
+
</if>
|
|
314
|
+
</li>
|
|
315
|
+
</if>
|
|
316
|
+
</for>
|
|
317
|
+
</ul>
|
|
318
|
+
</div>
|
|
319
|
+
</if>
|
|
320
|
+
|
|
321
|
+
{!
|
|
322
|
+
|
|
323
|
+
}
|
|
324
|
+
!}
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<if test="data.inheritsFrom.length">
|
|
328
|
+
<dl class="inheritsList">
|
|
329
|
+
{!
|
|
330
|
+
var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias});
|
|
331
|
+
|
|
332
|
+
var contributers = [];
|
|
333
|
+
borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
|
|
334
|
+
for (var i = 0, l = contributers.length; i < l; i++) {
|
|
335
|
+
output +=
|
|
336
|
+
"<dt>Properties borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
|
|
337
|
+
+
|
|
338
|
+
"<dd>" +
|
|
339
|
+
borrowedMembers
|
|
340
|
+
.filter(
|
|
341
|
+
function($) { return $.memberOf == contributers[i] }
|
|
342
|
+
)
|
|
343
|
+
.sort(makeSortby("name"))
|
|
344
|
+
.map(
|
|
345
|
+
function($) { return new Link().toSymbol($.alias).withText($.name) }
|
|
346
|
+
)
|
|
347
|
+
.join(", ")
|
|
348
|
+
+
|
|
349
|
+
"</dd>";
|
|
350
|
+
}
|
|
351
|
+
!}
|
|
352
|
+
</dl>
|
|
353
|
+
</if>
|
|
354
|
+
|
|
355
|
+
</if>
|
|
356
|
+
|
|
357
|
+
<if test="data.methods.length">
|
|
358
|
+
{!
|
|
359
|
+
var allMethods = data.methods.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("commonTask"));
|
|
360
|
+
|
|
361
|
+
var commonTasks = {};
|
|
362
|
+
var uncommonTasks = [];
|
|
363
|
+
var currentKey = '';
|
|
364
|
+
var commonLen = 0;
|
|
365
|
+
for(var k=0; k<allMethods.length; k++)
|
|
366
|
+
{
|
|
367
|
+
if(!allMethods[k].commonTask)
|
|
368
|
+
{
|
|
369
|
+
uncommonTasks.push(allMethods[k]);
|
|
370
|
+
continue;
|
|
371
|
+
}
|
|
372
|
+
if(allMethods[k].commonTask != currentKey)
|
|
373
|
+
{
|
|
374
|
+
currentKey = allMethods[k].commonTask;
|
|
375
|
+
commonTasks[currentKey] = [];
|
|
376
|
+
commonLen++;
|
|
377
|
+
}
|
|
378
|
+
commonTasks[currentKey].push(allMethods[k]);
|
|
379
|
+
}
|
|
380
|
+
uncommonTasks.sort(makeSortby("name"));
|
|
381
|
+
|
|
382
|
+
allMethods.sort(makeSortby("name"));
|
|
383
|
+
|
|
384
|
+
if(commonLen > 0)
|
|
385
|
+
{
|
|
386
|
+
|
|
387
|
+
!}
|
|
388
|
+
|
|
389
|
+
<if test="uncommonTasks.length">
|
|
390
|
+
<div class="field-summary summary">
|
|
391
|
+
<h2>General Method Summary</h2>
|
|
392
|
+
<ul>
|
|
393
|
+
<for each="method" in="uncommonTasks">
|
|
394
|
+
<li>
|
|
395
|
+
<a href="#{+method.alias+}">
|
|
396
|
+
<code class="type"><if test="method.isStatic||!method.memberOf">+</if><if test="!(method.isStatic||!method.memberOf)">-</if> <if test="method.isPrivate">private </if><if test="method.returns.length"><for each="ret" in="method.returns">({+ret.type+})</for></if><if test="method.returns.length == 0">(void)</if> {+method.name+}{+makeSignature(method.params)+}</code>
|
|
397
|
+
</a>
|
|
398
|
+
<if test="method.desc">
|
|
399
|
+
<div class="description">{+resolveLinks(summarize(method.desc))+}</div>
|
|
400
|
+
</if>
|
|
401
|
+
</li>
|
|
402
|
+
</for>
|
|
403
|
+
</ul>
|
|
404
|
+
</div>
|
|
405
|
+
</if>
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
{!
|
|
409
|
+
for(var key in commonTasks)
|
|
410
|
+
{
|
|
411
|
+
commonTasks[key].sort(makeSortby("name"));
|
|
412
|
+
var methods = commonTasks[key];
|
|
413
|
+
!}
|
|
414
|
+
|
|
415
|
+
<div class="field-summary summary">
|
|
416
|
+
<h2>Common Methods For '{! output+=key; !}'</h2>
|
|
417
|
+
<ul>
|
|
418
|
+
<for each="method" in="methods">
|
|
419
|
+
<li>
|
|
420
|
+
<a href="#{+method.alias+}">
|
|
421
|
+
<code class="type"><if test="method.isStatic||!method.memberOf">+</if><if test="!(method.isStatic||!method.memberOf)">-</if> <if test="method.isPrivate">private </if><if test="method.returns.length"><for each="ret" in="method.returns">({+ret.type+})</for></if><if test="method.returns.length == 0">(void)</if> {+method.name+}{+makeSignature(method.params)+}</code>
|
|
422
|
+
</a>
|
|
423
|
+
<if test="method.desc">
|
|
424
|
+
<div class="description">{+resolveLinks(summarize(method.desc))+}</div>
|
|
425
|
+
</if>
|
|
426
|
+
</li>
|
|
427
|
+
</for>
|
|
428
|
+
</ul>
|
|
429
|
+
</div>
|
|
430
|
+
|
|
431
|
+
{!
|
|
432
|
+
|
|
433
|
+
}
|
|
434
|
+
}
|
|
435
|
+
else
|
|
436
|
+
{
|
|
437
|
+
|
|
438
|
+
!}
|
|
439
|
+
|
|
440
|
+
<if test="allMethods.length">
|
|
441
|
+
<div class="method-summary summary">
|
|
442
|
+
<h2>Method Summary</h2>
|
|
443
|
+
<ul>
|
|
444
|
+
<for each="method" in="allMethods">
|
|
445
|
+
<li>
|
|
446
|
+
<a href="#{+method.alias+}">
|
|
447
|
+
<code class="type"><if test="method.isStatic||!method.memberOf">+</if><if test="!(method.isStatic||!method.memberOf)">-</if> <if test="method.isPrivate">private </if><if test="method.returns.length"><for each="ret" in="method.returns">({+ret.type+})</for></if><if test="method.returns.length == 0">(void)</if> {+method.name+}{+makeSignature(method.params)+}</code>
|
|
448
|
+
</a>
|
|
449
|
+
<if test="method.desc">
|
|
450
|
+
<div class="description">{+resolveLinks(summarize(method.desc))+}</div>
|
|
451
|
+
</if>
|
|
452
|
+
</li>
|
|
453
|
+
</for>
|
|
454
|
+
</ul>
|
|
455
|
+
</div>
|
|
456
|
+
</if>
|
|
457
|
+
|
|
458
|
+
{!
|
|
459
|
+
|
|
460
|
+
}
|
|
461
|
+
!}
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
<if test="data.inheritsFrom.length">
|
|
465
|
+
<dl class="inheritsList">
|
|
466
|
+
{!
|
|
467
|
+
var borrowedMembers = data.methods.filter(function($) {return $.memberOf != data.alias});
|
|
468
|
+
var contributers = [];
|
|
469
|
+
borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
|
|
470
|
+
for (var i = 0, l = contributers.length; i < l; i++) {
|
|
471
|
+
output +=
|
|
472
|
+
"<dt>Methods borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
|
|
473
|
+
+
|
|
474
|
+
"<dd>" +
|
|
475
|
+
borrowedMembers
|
|
476
|
+
.filter(
|
|
477
|
+
function($) { return $.memberOf == contributers[i] }
|
|
478
|
+
)
|
|
479
|
+
.sort(makeSortby("name"))
|
|
480
|
+
.map(
|
|
481
|
+
function($) { return new Link().toSymbol($.alias).withText($.name) }
|
|
482
|
+
)
|
|
483
|
+
.join(", ")
|
|
484
|
+
+
|
|
485
|
+
"</dd>";
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
!}
|
|
489
|
+
</dl>
|
|
490
|
+
</if>
|
|
491
|
+
</if>
|
|
492
|
+
|
|
493
|
+
<!-- ============================== field details ========================== -->
|
|
494
|
+
<if test="defined(allProps) && allProps.length">
|
|
495
|
+
<div class="field-detail detail">
|
|
496
|
+
<a name="field_detail"><h2>Property Details</h2></a>
|
|
497
|
+
<for each="property" in="allProps">
|
|
498
|
+
<if test="!(property.isConstant)">
|
|
499
|
+
<!-- One single method detail entry -->
|
|
500
|
+
<div class="field">
|
|
501
|
+
<a name="{+Link.symbolNameToLinkName(property)+}"></a>
|
|
502
|
+
<div class="field">
|
|
503
|
+
<a name="{+Link.symbolNameToLinkName(property)+}"></a>
|
|
504
|
+
<h3>{+property.name+}
|
|
505
|
+
|
|
506
|
+
<if test="property.isReadOnly == true">
|
|
507
|
+
[R/O]
|
|
508
|
+
</if>
|
|
509
|
+
<if test="property.isReadOnly == false">
|
|
510
|
+
[R/W]
|
|
511
|
+
</if>
|
|
512
|
+
|
|
513
|
+
</h3>
|
|
514
|
+
<p class="summary">{+summarize(property.desc)+}</p>
|
|
515
|
+
|
|
516
|
+
<if test="property.deprecated">
|
|
517
|
+
<p class="deprecated">Deprecated {+property.deprecated+}</p>
|
|
518
|
+
</if>
|
|
519
|
+
|
|
520
|
+
<p class="signature">
|
|
521
|
+
<if test="property.isStatic||!property.memberOf">+</if>
|
|
522
|
+
<if test="!(property.isStatic||!property.memberOf)">-</if>
|
|
523
|
+
|
|
524
|
+
<span class="type">
|
|
525
|
+
<if test="property.isPrivate">private </if>
|
|
526
|
+
{+(property.type||"Object")+}
|
|
527
|
+
</span>
|
|
528
|
+
<span class="name">{+property.name+}</span>
|
|
529
|
+
</p>
|
|
530
|
+
|
|
531
|
+
<if test="property.binding.length">
|
|
532
|
+
<for each="bind" in="property.binding">
|
|
533
|
+
<p class="parameter">
|
|
534
|
+
<strong>Bound To: </strong><span class="type">{+bind+}</span>
|
|
535
|
+
</p>
|
|
536
|
+
</for>
|
|
537
|
+
</if>
|
|
538
|
+
|
|
539
|
+
<if test="property.defaultValue">
|
|
540
|
+
<p class="parameter">
|
|
541
|
+
<strong>Default Value: </strong> <span class="type">{+property.defaultValue+}</span>
|
|
542
|
+
</p>
|
|
543
|
+
</if>
|
|
544
|
+
|
|
545
|
+
{!
|
|
546
|
+
if(property.desc.split('.').length > 2)
|
|
547
|
+
{
|
|
548
|
+
|
|
549
|
+
output+= "<h5>Discussion</h5>";
|
|
550
|
+
output+= '<div class="description">'+htmlize(property.desc)+'</div>';
|
|
551
|
+
|
|
552
|
+
}
|
|
553
|
+
!}
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
<if test="property.since">
|
|
557
|
+
<h5>Availability</h5>
|
|
558
|
+
<div class="since">since {+property.since+}</div>
|
|
559
|
+
</if>
|
|
560
|
+
</div>
|
|
561
|
+
<hr/>
|
|
562
|
+
</if>
|
|
563
|
+
</for>
|
|
564
|
+
</div>
|
|
565
|
+
</if>
|
|
566
|
+
|
|
567
|
+
<!-- ============================== method details ========================= -->
|
|
568
|
+
<if test="defined(allMethods) && allMethods.length">
|
|
569
|
+
<h2>
|
|
570
|
+
Method Detail
|
|
571
|
+
</h2>
|
|
572
|
+
<for each="method" in="allMethods">
|
|
573
|
+
<div class="method detail">
|
|
574
|
+
<a name="{+method.alias+}"></a>
|
|
575
|
+
<h3>{+method.name+}()
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
<if test="method.commonTask">
|
|
579
|
+
- {+method.commonTask+}
|
|
580
|
+
</if>
|
|
581
|
+
|
|
582
|
+
</h3>
|
|
583
|
+
<p class="summary">{+summarize(method.desc)+}</p>
|
|
584
|
+
|
|
585
|
+
<if test="method.deprecated">
|
|
586
|
+
<p class="deprecated">Deprecated {+method.deprecated+}</p>
|
|
587
|
+
</if>
|
|
588
|
+
|
|
589
|
+
<p class="signature">
|
|
590
|
+
<if test="method.isStatic||!method.memberOf">+</if>
|
|
591
|
+
<if test="!(method.isStatic||!method.memberOf)">-</if>
|
|
592
|
+
|
|
593
|
+
<span class="type">
|
|
594
|
+
<if test="method.isPrivate">private </if>
|
|
595
|
+
({+(method.type||"void")+})
|
|
596
|
+
</span>
|
|
597
|
+
<span class="name">{+method.name+}</span> <span class="params">{+makeSignature(method.params)+}</span>
|
|
598
|
+
</p>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
<!-- METHOD PARAMETERS START -->
|
|
602
|
+
<if test="hasUsefulParams(method.params)">
|
|
603
|
+
<h5>Parameters</h5>
|
|
604
|
+
<for each="param" in="method.params">
|
|
605
|
+
<if test="isUsefulParam(param)">
|
|
606
|
+
<p class="parameter">
|
|
607
|
+
<if test="param.type"><span class="type">({+param.type+})</span></if><span class="name">{+param.name+}</span>
|
|
608
|
+
<if test="param.desc">
|
|
609
|
+
<span class="desc">{+resolveLinks(param.desc)+}</span>
|
|
610
|
+
</if>
|
|
611
|
+
</p>
|
|
612
|
+
</if>
|
|
613
|
+
</for>
|
|
614
|
+
</if>
|
|
615
|
+
<!-- METHOD PARAMETERS END -->
|
|
616
|
+
|
|
617
|
+
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
618
|
+
<if test="method.returns.length">
|
|
619
|
+
<h5>Returns</h5>
|
|
620
|
+
<for each="ret" in="method.returns">
|
|
621
|
+
<p class="parameter">
|
|
622
|
+
<if test="ret.type"><span class="type">({+ret.type+})</span></if>
|
|
623
|
+
<span class="desc">{+resolveLinks(ret.desc)+}</span>
|
|
624
|
+
</p>
|
|
625
|
+
</for>
|
|
626
|
+
</if>
|
|
627
|
+
|
|
628
|
+
<if test="method.observes.length">
|
|
629
|
+
<h5>Observes</h5>
|
|
630
|
+
<for each="obs" in="method.observes">
|
|
631
|
+
<p class="parameter">
|
|
632
|
+
<span class="type">{+obs+}</span>
|
|
633
|
+
</p>
|
|
634
|
+
</for>
|
|
635
|
+
</if>
|
|
636
|
+
|
|
637
|
+
<if test="method.exceptions.length">
|
|
638
|
+
<h5>Throws Exceptions</h5>
|
|
639
|
+
<for each="ex" in="method.exceptions">
|
|
640
|
+
<p class="parameter">
|
|
641
|
+
<if test="ex.type"><span class="type">({+ex.type+})</span></if>
|
|
642
|
+
<span class="desc">{+resolveLinks(ex.desc)+}</span>
|
|
643
|
+
</p>
|
|
644
|
+
</for>
|
|
645
|
+
</if>
|
|
646
|
+
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
647
|
+
|
|
648
|
+
{!
|
|
649
|
+
if(method.desc.split('.').length > 2)
|
|
650
|
+
{
|
|
651
|
+
|
|
652
|
+
output+= "<h5>Discussion</h5>";
|
|
653
|
+
output+= '<div class="description">'+htmlize(method.desc)+'</div>';
|
|
654
|
+
|
|
655
|
+
}
|
|
656
|
+
!}
|
|
657
|
+
|
|
658
|
+
<if test="method.since">
|
|
659
|
+
<h5>Availability</h5>
|
|
660
|
+
<div class="since">since {+method.since+}</div>
|
|
661
|
+
</if>
|
|
662
|
+
</div>
|
|
663
|
+
<hr/>
|
|
664
|
+
</for>
|
|
665
|
+
</if>
|
|
666
|
+
</div>
|
|
667
|
+
|
|
668
|
+
<!-- ============================== footer ================================= -->
|
|
669
|
+
<div class="fineprint" style="clear:both">
|
|
670
|
+
<if test="JSDOC.opt.D.copyright">©{+JSDOC.opt.D.copyright+}<br /></if>
|
|
671
|
+
Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
|
|
672
|
+
</div>
|
|
673
|
+
</body>
|
|
674
|
+
</html>
|