Gitiles
Code Review Sign In
gerrit.omnirom.org / android_build / d3aa4000e42fd1036e0e3286843c5132f905d754 / . / tools / droiddoc / templates / class.cs
blob: 19df5fb7863d9ce92fabf699e69666bd2a1409bb [file] [log] [blame]
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]1<?cs include:"macros.cs" ?>
2<html>
3<?cs include:"head_tag.cs" ?>
4<body>
5<script type="text/javascript">
6function toggle_inherited(base) {
7 var list = document.getElementById(base + "-list");
8 var summary = document.getElementById(base + "-summary");
9 var trigger = document.getElementById(base + "-trigger");
10 if (list.style.display == "none") {
11 list.style.display = "block";
12 summary.style.display = "none";
13 trigger.src = "<?cs var:toroot ?>assets/triangle-open.png";
14 } else {
15 list.style.display = "none";
16 summary.style.display = "block";
17 trigger.src = "<?cs var:toroot ?>assets/triangle-close.png";
18 }
19}
20</script>
21<?cs include:"header.cs" ?>
22
23<div class="g-unit" id="doc-content">
24
25<?cs # this next line must be exactly like this to be parsed by eclipse ?>
26<!-- ======== START OF CLASS DATA ======== -->
27
28<div id="jd-header">
29 <?cs var:class.scope ?>
30 <?cs var:class.static ?>
31 <?cs var:class.final ?>
32 <?cs var:class.abstract ?>
33 <?cs var:class.kind ?>
34<h1><?cs var:class.name ?></h1>
35
36<?cs set:colspan = subcount(class.inheritance) ?>
37<?cs each:supr = class.inheritance ?>
38 <?cs if:colspan == 2 ?>
39 extends <?cs call:type_link(supr.short_class) ?><br/>
40 <?cs /if ?>
41 <?cs if:last(supr) && subcount(supr.interfaces) ?>
42 implements
43 <?cs each:t=supr.interfaces ?>
44 <?cs call:type_link(t) ?>
45 <?cs /each ?>
46 <?cs /if ?>
47 <?cs set:colspan = colspan-1 ?>
48<?cs /each ?>
49
50</div><!-- end header -->
51
52
53<div id="jd-content">
54<table class="jd-inheritance-table">
55<?cs set:colspan = subcount(class.inheritance) ?>
56<?cs each:supr = class.inheritance ?>
57 <tr>
58 <?cs loop:i = 1, (subcount(class.inheritance)-colspan), 1 ?>
59 <td class="jd-inheritance-space">&nbsp;<?cs if:(subcount(class.inheritance)-colspan) == i ?>&nbsp;&nbsp;&#x21b3;<?cs /if ?></td>
60 <?cs /loop ?>
61 <td colspan="<?cs var:colspan ?>" class="jd-inheritance-class-cell"><?cs
62 if:colspan == 1
63 ?><?cs call:class_name(class.qualifiedType) ?><?cs
64 else
65 ?><?cs call:type_link(supr.class) ?><?cs
66 /if ?></td>
67 </tr>
68 <?cs set:colspan = colspan-1 ?>
69<?cs /each ?>
70</table>
71
72
73<div class="jd-descr">
74<?cs call:deprecated_warning(class) ?>
75<?cs if:subcount(class.descr) ?>
76<h2>Class Overview</h2>
77<p><?cs call:tag_list(class.descr) ?></p>
78<?cs /if ?>
79
80<?cs # this next line must be exactly like this to be parsed by eclipse ?>
81<!-- ======== NESTED CLASS SUMMARY ======== -->
82<?cs if:subcount(class.inners) ?>
83<h4><?cs call:expando_trigger("nested-classes", "close") ?>Nested Classes</h4>
84<?cs call:expandable_class_list("nested-classes", class.inners, "summary") ?>
85<?cs /if ?>
86
87<?cs if:subcount(class.subclasses.direct) ?>
88<h4><?cs call:expando_trigger("subclasses-direct", "open") ?>Known Direct Subclasses</h4>
89<?cs call:expandable_class_list("subclasses-direct", class.subclasses.direct, "list") ?>
90<?cs /if ?>
91
92<?cs if:subcount(class.subclasses.indirect) ?>
93<h4><?cs call:expando_trigger("subclasses-indirect", "open") ?>Known Indirect Subclasses</h4>
94<?cs call:expandable_class_list("subclasses-indirect", class.subclasses.indirect, "list") ?>
95<?cs /if ?>
96
97<?cs call:see_also_tags(class.seeAlso) ?>
98
99</div><!-- jd-descr -->
100
101
102<?cs # summar macros ?>
103
104<?cs def:write_method_summary(methods) ?>
105<?cs set:count = #1 ?>
106<table class="jd-linktable">
107<?cs each:method = methods ?>
108 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
109 <td class="jd-typecol"><nobr>
110 <?cs var:method.abstract ?>
111 <?cs var:method.synchronized ?>
112 <?cs var:method.final ?>
113 <?cs var:method.static ?>
114 <?cs call:type_link(method.generic) ?>
115 <?cs call:type_link(method.returnType) ?></nobr>
116 </td>
117 <td class="jd-linkcol" width="100%"><a href="<?cs var:toroot ?><?cs var:method.href ?>"><strong><?cs var:method.name ?></strong></a>(<?cs call:parameter_list(method.params) ?>)</td>
118 </tr>
119 <?cs if:subcount(method.shortDescr) || subcount(method.deprecated) ?>
120 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
121 <td class="jd-commentrow"></td>
122 <td class="jd-commentrow"><?cs call:short_descr(method) ?></td>
123 </tr>
124 <?cs /if ?>
125<?cs set:count = count + #1 ?>
126<?cs /each ?>
127</table>
128<?cs /def ?>
129
130<?cs def:write_field_summary(fields) ?>
131<?cs set:count = #1 ?>
132<table class="jd-linktable">
133 <?cs each:field=fields ?>
134 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
135 <td class="jd-descrcol"><?cs var:field.scope ?>&nbsp;</td>
136 <td class="jd-descrcol"><?cs var:field.static ?>&nbsp;</td>
137 <td class="jd-descrcol"><?cs var:field.final ?>&nbsp;</td>
138 <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
139 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a>&nbsp;</td>
140 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?>&nbsp;</td>
141 </tr>
142 <?cs set:count = count + #1 ?>
143 <?cs /each ?>
144</table>
145<?cs /def ?>
146
147<?cs def:write_constant_summary(fields) ?>
148<?cs set:count = #1 ?>
149<table class="jd-linktable">
150
151 <?cs each:field=fields ?>
152 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
153 <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
154 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a>&nbsp;</td>
155 <td class="jd-descrcol"><?cs call:short_descr(field) ?>&nbsp;</td>
156 </tr>
157 <?cs set:count = count + #1 ?>
158 <?cs /each ?>
159</table>
160<?cs /def ?>
161
162<?cs def:write_attr_summary(attrs) ?>
163<?cs set:count = #1 ?>
164<table class="jd-linktable">
165 <tr>
166 <th>Attribute name</th>
167 <th>Related methods</th>
168 <th>&nbsp;</th>
169 </tr>
170 <?cs each:attr=attrs ?>
171 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
172 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:attr.href ?>"><?cs var:attr.name ?></a></td>
173 <td class="jd-linkcol"><?cs each:m=attr.methods
174 ?><a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a><br/>
175 <?cs /each ?>&nbsp;
176 </td>
177 <td class="jd-descrcol" width="100%"><?cs call:short_descr(attr) ?>&nbsp;</td>
178 </tr>
179 <?cs set:count = count + #1 ?>
180 <?cs /each ?>
181</table>
182<?cs /def ?>
183
184<?cs # end macros ?>
185
186<div class="jd-descr">
187<h2>Summary</h2>
188
189<?cs # this next line must be exactly like this to be parsed by eclipse ?>
190<!-- =========== FIELD SUMMARY =========== -->
191<?cs if:subcount(class.attrs) ?>
192<h3>XML Attributes</h3>
193<?cs call:write_attr_summary(class.attrs) ?>
194<?cs /if ?>
195
196<?cs each:cl=class.inherited ?>
197<?cs if:subcount(cl.attrs) ?>
198<h4><?cs call:expando_trigger("inherited-attrs-"+cl.qualified, "open") ?>XML Attributes inherited
199 from <?cs var:cl.kind ?>
200 <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
201</h4>
202<div id="inherited-attrs-<?cs var:cl.qualified ?>">
203 <div id="inherited-attrs-<?cs var:cl.qualified ?>-list"
204 class="jd-inheritedlinks">
205 </div>
206 <div id="inherited-attrs-<?cs var:cl.qualified ?>-summary"
207 style="display: none;">
208 <?cs call:write_attr_summary(cl.attrs) ?>
209 </div>
210</div>
211<?cs /if ?>
212<?cs /each ?>
213
214
215
216<?cs if:subcount(class.enumConstants) ?>
217<?cs # this next line must be exactly like this to be parsed by eclipse ?>
218<!-- =========== ENUM CONSTANT SUMMARY =========== -->
219<h3>Enum Values</h3>
220<?cs set:count = #1 ?>
221<table class="jd-linktable">
222 <?cs each:field=class.enumConstants ?>
223 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
224 <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
225 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a>&nbsp;</td>
226 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?>&nbsp;</td>
227 </tr>
228 <?cs set:count = count + #1 ?>
229 <?cs /each ?>
230</table>
231<?cs /if ?>
232
233<?cs if:subcount(class.constants) ?>
234<?cs # this next line must be exactly like this to be parsed by eclipse ?>
235<!-- =========== FIELD SUMMARY =========== -->
236<h3>Constants</h3>
237<?cs call:write_constant_summary(class.constants) ?>
238<?cs /if ?>
239
240<?cs each:cl=class.inherited ?>
241<?cs if:subcount(cl.constants) ?>
242<h4><?cs call:expando_trigger("inherited-constants-"+cl.qualified, "open") ?>Constants inherited
243 from <?cs var:cl.kind ?>
244 <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
245</h4>
246<div id="inherited-constants-<?cs var:cl.qualified ?>">
247<div id="inherited-constants-<?cs var:cl.qualified ?>-list"
248 class="jd-inheritedlinks">
249
250</div>
251<div id="inherited-constants-<?cs var:cl.qualified ?>-summary"
252 style="display: none;">
253<?cs call:write_constant_summary(cl.constants) ?>
254</div>
255</div>
256<?cs /if ?>
257<?cs /each ?>
258
259
260<?cs if:subcount(class.fields) ?>
261<?cs # this next line must be exactly like this to be parsed by eclipse ?>
262<!-- =========== FIELD SUMMARY =========== -->
263<h3>Fields</h3>
264<?cs call:write_field_summary(class.fields) ?>
265<?cs /if ?>
266
267<?cs each:cl=class.inherited ?>
268<?cs if:subcount(cl.fields) ?>
269<h4><?cs call:expando_trigger("inherited-fields-"+cl.qualified, "open") ?>Fields inherited
270 from <?cs var:cl.kind ?>
271 <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
272</h4>
273<div id="inherited-fields-<?cs var:cl.qualified ?>">
274<div id="inherited-fields-<?cs var:cl.qualified ?>-list"
275 class="jd-inheritedlinks">
276
277</div>
278<div id="inherited-fields-<?cs var:cl.qualified ?>-summary"
279 style="display: none;">
280<?cs call:write_field_summary(cl.fields) ?>
281</div>
282</div>
283<?cs /if ?>
284<?cs /each ?>
285
286
287<?cs if:subcount(class.ctors.public) ?>
288<?cs # this next line must be exactly like this to be parsed by eclipse ?>
289<!-- ======== CONSTRUCTOR SUMMARY ======== -->
290<h3>Public Constructors</h3>
291<?cs call:write_method_summary(class.ctors.public) ?>
292<?cs /if ?>
293
294<?cs if:subcount(class.ctors.protected) ?>
295<?cs # this next line must be exactly like this to be parsed by eclipse ?>
296<!-- ======== CONSTRUCTOR SUMMARY ======== -->
297<h3>Protected Constructors</h3>
298<?cs call:write_method_summary(class.ctors.protected) ?>
299<?cs /if ?>
300
301<?cs if:subcount(class.methods.public) ?>
302<?cs # this next line must be exactly like this to be parsed by eclipse ?>
303<!-- ========== METHOD SUMMARY =========== -->
304<h3>Public Methods</h3>
305<?cs call:write_method_summary(class.methods.public) ?>
306<?cs /if ?>
307
308<?cs if:subcount(class.methods.protected) ?>
309<?cs # this next line must be exactly like this to be parsed by eclipse ?>
310<!-- ========== METHOD SUMMARY =========== -->
311<h3>Protected Methods</h3>
312<?cs call:write_method_summary(class.methods.protected) ?>
313<?cs /if ?>
314
315<?cs each:cl=class.inherited ?>
316<?cs if:subcount(cl.methods) ?>
317<h4><?cs call:expando_trigger("inherited-methods-"+cl.qualified, "open") ?>Methods inherited
318 from <?cs var:cl.kind ?>
319 <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
320</h4>
321<div id="inherited-methods-<?cs var:cl.qualified ?>">
322<div id="inherited-methods-<?cs var:cl.qualified ?>-list"
323 class="jd-inheritedlinks">
324
325</div>
326<div id="inherited-methods-<?cs var:cl.qualified ?>-summary"
327 style="display: none;">
328<?cs call:write_method_summary(cl.methods) ?>
329</div>
330</div>
331<?cs /if ?>
332<?cs /each ?>
333
334</div><!-- jd-descr (summary) -->
335
336<!-- Details -->
337
338<?cs def:write_field_details(fields) ?>
339<?cs each:field=fields ?>
340<?cs # this next line must be exactly like this to be parsed by eclipse ?>
341<div class="jd-details" id="<?cs var:field.anchor ?>">
342 <h4 class="jd-details-title">
343 <span class="normal">
344 <?cs var:field.scope ?>
345 <?cs var:field.static ?>
346 <?cs var:field.final ?>
347 <?cs call:type_link(field.type) ?>
348 </span>
349 <?cs var:field.name ?>
350 </h4>
351 <div class="jd-details-descr"><?cs call:description(field) ?>
352 <?cs if:subcount(field.constantValue) ?>
353 <div class="jd-tagdata">
354 <span class="jd-tagtitle">Constant Value: </span>
355 <span>
356 <?cs if:field.constantValue.isString ?>
357 <?cs var:field.constantValue.str ?>
358 <?cs else ?>
359 <?cs var:field.constantValue.dec ?>
360 (<?cs var:field.constantValue.hex ?>)
361 <?cs /if ?>
362 </span>
363 </div>
364 <?cs /if ?>
365 </div>
366</div>
367<?cs /each ?>
368<?cs /def ?>
369
370<?cs def:write_method_details(methods) ?>
371<?cs each:method=methods ?>
372<?cs # this next line must be exactly like this to be parsed by eclipse ?>
373<div class="jd-details" id="<?cs var:method.anchor ?>">
374 <h4 class="jd-details-title">
375 <span class="normal">
376 <?cs var:method.scope ?>
377 <?cs var:method.static ?>
378 <?cs var:method.final ?>
379 <?cs var:method.abstract ?>
380 <?cs var:method.synchronized ?>
381 <?cs call:type_link(method.returnType) ?>
382 </span>
383 <?cs var:method.name ?>(<?cs call:parameter_list(method.params) ?>)
384 </h4>
385 <div class="jd-details-descr"><?cs call:description(method) ?></div>
386</div>
387<?cs /each ?>
388<?cs /def ?>
389
390<?cs def:write_attr_details(attrs) ?>
391<?cs each:attr=attrs ?>
392<?cs # this next line must be exactly like this to be parsed by eclipse ?>
393<div class="jd-details" id="<?cs var:attr.anchor ?>">
394 <h4 class="jd-details-title"><?cs var:attr.name ?></h4>
395 <div class="jd-details-descr">
396 <?cs call:description(attr) ?>
397
398 <div class="jd-tagdata">
399 <h5 class="jd-tagtitle">Related Methods</h5>
400 <ul class="nolist">
401 <?cs each:m=attr.methods ?>
402 <li><a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a></li>
403 <?cs /each ?>
404 </ul>
405 </div>
406 </div>
407</div>
408<?cs /each ?>
409<?cs /def ?>
410
411
412<!-- XML Attributes -->
413<?cs if:subcount(class.attrs) ?>
414<h2>XML Attributes</h2>
415<?cs call:write_attr_details(class.attrs) ?>
416<?cs /if ?>
417
418<!-- Enum Values -->
419<?cs if:subcount(class.enumConstants) ?>
420<h2>Enum Values</h2>
421<?cs call:write_field_details(class.enumConstants) ?>
422<?cs /if ?>
423
424<!-- Constants -->
425<?cs if:subcount(class.constants) ?>
426<h2>Constants</h2>
427<?cs call:write_field_details(class.constants) ?>
428<?cs /if ?>
429
430<!-- Fields -->
431<?cs if:subcount(class.fields) ?>
432<h2>Fields</h2>
433<?cs call:write_field_details(class.fields) ?>
434<?cs /if ?>
435
436<!-- Public ctors -->
437<?cs if:subcount(class.ctors.public) ?>
438<h2>Public Constructors</h2>
439<?cs call:write_method_details(class.ctors.public) ?>
440<?cs /if ?>
441
442<?cs # this next line must be exactly like this to be parsed by eclipse ?>
443<!-- ========= CONSTRUCTOR DETAIL ======== -->
444<!-- Protected ctors -->
445<?cs if:subcount(class.ctors.protected) ?>
446<h2>Protected Constructors</h2>
447<?cs call:write_method_details(class.ctors.protected) ?>
448<?cs /if ?>
449
450<?cs # this next line must be exactly like this to be parsed by eclipse ?>
451<!-- ========= CONSTRUCTOR DETAIL ======== -->
452<!-- Public methdos -->
453<?cs if:subcount(class.methods.public) ?>
454<h2>Public Methods</h2>
455<?cs call:write_method_details(class.methods.public) ?>
456<?cs /if ?>
457
458<?cs # this next line must be exactly like this to be parsed by eclipse ?>
459<!-- ========= METHOD DETAIL ======== -->
460<?cs if:subcount(class.methods.protected) ?>
461<h2>Protected Methods</h2>
462<?cs call:write_method_details(class.methods.protected) ?>
463<?cs /if ?>
464
465<?cs # this next line must be exactly like this to be parsed by eclipse ?>
466<!-- ========= END OF CLASS DATA ========= -->
467
468<?cs include:"footer.cs" ?>
469</div> <!-- jd-content -->
470
471</div><!-- end doc-content -->
472<?cs include:"analytics.cs" ?>
473</body>
474</html>