diff options
Diffstat (limited to 'tools/droiddoc/templates/class.cs')
-rw-r--r-- | tools/droiddoc/templates/class.cs | 326 |
1 files changed, 221 insertions, 105 deletions
diff --git a/tools/droiddoc/templates/class.cs b/tools/droiddoc/templates/class.cs index 1fd4369..005ed6a 100644 --- a/tools/droiddoc/templates/class.cs +++ b/tools/droiddoc/templates/class.cs @@ -23,6 +23,84 @@ function toggle_inherited(base) { <div class="g-unit" id="doc-content"> +<div id="api-info-block"> + +<?cs # are there inherited members ?> +<?cs each:cl=class.inherited ?> + <?cs if:subcount(cl.methods) ?> + <?cs set:inhmethods = #1 ?> + <?cs /if ?> + <?cs if:subcount(cl.constants) ?> + <?cs set:inhconstants = #1 ?> + <?cs /if ?> + <?cs if:subcount(cl.fields) ?> + <?cs set:inhfields = #1 ?> + <?cs /if ?> + <?cs if:subcount(cl.attrs) ?> + <?cs set:inhattrs = #1 ?> + <?cs /if ?> +<?cs /each ?> + +<div class="sum-details-links"> +Summary: +<?cs if:subcount(class.inners) ?> + <a href="#nestedclasses">Nested Classes</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:subcount(class.attrs) ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#lattrs">XML Attrs</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:inhattrs ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#inhattrs">Inherited XML Attrs</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:subcount(class.enumConstants) ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#enumconstants">Enums</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:subcount(class.constants) ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#constants">Constants</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:inhconstants ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#inhconstants">Inherited Constants</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:subcount(class.fields) ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#lfields">Fields</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:inhfields ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#inhfields">Inherited Fields</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:subcount(class.ctors.public) ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#pubctors">Ctors</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:subcount(class.ctors.protected) ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#proctors">Protected Ctors</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:subcount(class.methods.public) ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#pubmethods">Methods</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:subcount(class.methods.protected) ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#promethods">Protected Methods</a> + <?cs set:linkcount = #1 ?> +<?cs /if ?> +<?cs if:inhmethods ?> + <?cs if:linkcount ?>| <?cs /if ?><a href="#inhmethods">Inherited Methods</a> +<?cs /if ?> +</nobr> +<?cs if:inhattrs || inhconstants || inhfields || inhmethods || subcount(class.subclasses.direct) || subcount(class.subclasses.indirect) ?> +| [<a href="">Expand All</a>] +<?cs /if ?> +</div> +</div> + <?cs # this next line must be exactly like this to be parsed by eclipse ?> <!-- ======== START OF CLASS DATA ======== --> @@ -58,7 +136,7 @@ function toggle_inherited(base) { <tr> <?cs loop:i = 1, (subcount(class.inheritance)-colspan), 1 ?> <td class="jd-inheritance-space"> <?cs if:(subcount(class.inheritance)-colspan) == i ?> ↳<?cs /if ?></td> - <?cs /loop ?> + <?cs /loop ?> <td colspan="<?cs var:colspan ?>" class="jd-inheritance-class-cell"><?cs if:colspan == 1 ?><?cs call:class_name(class.qualifiedType) ?><?cs @@ -70,29 +148,27 @@ function toggle_inherited(base) { <?cs /each ?> </table> - -<div class="jd-descr"> -<?cs call:deprecated_warning(class) ?> -<?cs if:subcount(class.descr) ?> -<h2>Class Overview</h2> -<p><?cs call:tag_list(class.descr) ?></p> -<?cs /if ?> - <?cs # this next line must be exactly like this to be parsed by eclipse ?> <!-- ======== NESTED CLASS SUMMARY ======== --> -<?cs if:subcount(class.inners) ?> -<h4><?cs call:expando_trigger("nested-classes", "opened") ?>Nested Classes</h4> -<?cs call:expandable_class_list("nested-classes", class.inners, "summary") ?> -<?cs /if ?> - <?cs if:subcount(class.subclasses.direct) ?> -<h4><?cs call:expando_trigger("subclasses-direct", "closed") ?>Known Direct Subclasses</h4> +<table class="jd-sumtable jd-sumtable-subclasses"><tr><td colspan="12" style="border:none;margin:0;padding:0;"> +<?cs call:expando_trigger("subclasses-direct", "closed") ?>Known Direct Subclasses <?cs call:expandable_class_list("subclasses-direct", class.subclasses.direct, "list") ?> +</td></tr></table> <?cs /if ?> <?cs if:subcount(class.subclasses.indirect) ?> -<h4><?cs call:expando_trigger("subclasses-indirect", "closed") ?>Known Indirect Subclasses</h4> +<table class="jd-sumtable jd-sumtable-subclasses"><tr><td colspan="12" style="border:none;margin:0;padding:0;"> +<?cs call:expando_trigger("subclasses-indirect", "closed") ?>Known Indirect Subclasses <?cs call:expandable_class_list("subclasses-indirect", class.subclasses.indirect, "list") ?> +</td></tr></table> +<?cs /if ?> + +<div class="jd-descr"> +<?cs call:deprecated_warning(class) ?> +<?cs if:subcount(class.descr) ?> +<h2>Class Overview</h2> +<p><?cs call:tag_list(class.descr) ?></p> <?cs /if ?> <?cs call:see_also_tags(class.seeAlso) ?> @@ -100,11 +176,10 @@ function toggle_inherited(base) { </div><!-- jd-descr --> -<?cs # summar macros ?> +<?cs # summary macros ?> <?cs def:write_method_summary(methods) ?> <?cs set:count = #1 ?> -<table class="jd-linktable"> <?cs each:method = methods ?> <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> > <td class="jd-typecol"><nobr> @@ -115,71 +190,80 @@ function toggle_inherited(base) { <?cs call:type_link(method.generic) ?> <?cs call:type_link(method.returnType) ?></nobr> </td> - <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> - </tr> - <?cs if:subcount(method.shortDescr) || subcount(method.deprecated) ?> - <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> > - <td class="jd-commentrow"></td> - <td class="jd-commentrow"><?cs call:short_descr(method) ?></td> - </tr> + <td class="jd-linkcol" width="100%"><nobr> + <span class="sympad"><a href="<?cs var:toroot ?><?cs var:method.href ?>"> + <?cs var:method.name ?></a></span>(<?cs call:parameter_list(method.params) ?>)</nobr> + <?cs if:subcount(method.shortDescr) || subcount(method.deprecated) ?> + <div class="jd-descrdiv"><?cs call:short_descr(method) ?></div> <?cs /if ?> + </td></tr> <?cs set:count = count + #1 ?> <?cs /each ?> -</table> <?cs /def ?> <?cs def:write_field_summary(fields) ?> <?cs set:count = #1 ?> -<table class="jd-linktable"> <?cs each:field=fields ?> <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> > - <td class="jd-descrcol"><?cs var:field.scope ?> </td> - <td class="jd-descrcol"><?cs var:field.static ?> </td> - <td class="jd-descrcol"><?cs var:field.final ?> </td> - <td class="jd-descrcol"><?cs call:type_link(field.type) ?> </td> - <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a> </td> - <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?> </td> + <td class="jd-typecol"><nobr> + <?cs var:field.scope ?> + <?cs var:field.static ?> + <?cs var:field.final ?> + <?cs call:type_link(field.type) ?></nobr></td> + <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a></td> + <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td> </tr> <?cs set:count = count + #1 ?> <?cs /each ?> -</table> <?cs /def ?> <?cs def:write_constant_summary(fields) ?> <?cs set:count = #1 ?> -<table class="jd-linktable"> - <?cs each:field=fields ?> <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> > - <td class="jd-descrcol"><?cs call:type_link(field.type) ?> </td> - <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a> </td> - <td class="jd-descrcol"><?cs call:short_descr(field) ?> </td> + <td class="jd-typecol"><?cs call:type_link(field.type) ?></td> + <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a></td> + <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td> </tr> <?cs set:count = count + #1 ?> <?cs /each ?> -</table> <?cs /def ?> <?cs def:write_attr_summary(attrs) ?> <?cs set:count = #1 ?> -<table class="jd-linktable"> <tr> - <th>Attribute name</th> - <th>Related methods</th> - <th> </th> + <td><nobr><em>Attribute Name</em></nobr></td> + <td><nobr><em>Related Method</em></nobr></td> + <td><nobr><em>Description</em></nobr></td> </tr> <?cs each:attr=attrs ?> <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> > <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:attr.href ?>"><?cs var:attr.name ?></a></td> - <td class="jd-linkcol"><?cs each:m=attr.methods - ?><a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a><br/> - <?cs /each ?> + <td class="jd-linkcol"><?cs each:m=attr.methods ?> + <a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a> + <?cs /each ?> </td> <td class="jd-descrcol" width="100%"><?cs call:short_descr(attr) ?> </td> </tr> <?cs set:count = count + #1 ?> <?cs /each ?> -</table> +<?cs /def ?> + +<?cs def:write_inners_summary(classes) ?> +<?cs set:count = #1 ?> + <?cs each:cl=class.inners ?> + <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> > + <td class="jd-typecol"><nobr> + <?cs var:class.scope ?> + <?cs var:class.static ?> + <?cs var:class.final ?> + <?cs var:class.abstract ?> + <?cs var:class.kind ?></nobr></td> + <td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td> + <td class="jd-descrcol" width="100%"><?cs call:short_descr(cl) ?> </td> + </tr> + <?cs set:count = count + #1 ?> + <?cs /each ?> <?cs /def ?> <?cs # end macros ?> @@ -187,39 +271,50 @@ function toggle_inherited(base) { <div class="jd-descr"> <h2>Summary</h2> +<?cs if:subcount(class.inners) ?> +<?cs # this next line must be exactly like this to be parsed by eclipse ?> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<table id="nestedclasses" class="jd-sumtable"><tr><th colspan="12">Nested Classes</th></tr> +<?cs call:write_inners_summary(class.inners) ?> +<?cs /if ?> + <?cs # this next line must be exactly like this to be parsed by eclipse ?> -<!-- =========== FIELD SUMMARY =========== --> <?cs if:subcount(class.attrs) ?> -<h3>XML Attributes</h3> +<!-- =========== FIELD SUMMARY =========== --> +<table id="lattrs" class="jd-sumtable"><tr><th colspan="12">XML Attributes</th></tr> <?cs call:write_attr_summary(class.attrs) ?> <?cs /if ?> +<?cs # if there are inherited attrs, write the table ?> +<?cs if:inhattrs ?> +<table id="inhattrs" class="jd-sumtable"><tr><th> + <div class="expandall">[<a href="">Expand All</a>]</div> + <div style="clear:left;">Inherited XML Attributes</div></th></tr> <?cs each:cl=class.inherited ?> <?cs if:subcount(cl.attrs) ?> -<h4><?cs call:expando_trigger("inherited-attrs-"+cl.qualified, "closed") ?>XML Attributes inherited - from <?cs var:cl.kind ?> - <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a> -</h4> +<tr><td colspan="12"> +<?cs call:expando_trigger("inherited-attrs-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?> +<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a> <div id="inherited-attrs-<?cs var:cl.qualified ?>"> <div id="inherited-attrs-<?cs var:cl.qualified ?>-list" - class="jd-inheritedlinks"> + class="jd-inheritedlinks"> </div> - <div id="inherited-attrs-<?cs var:cl.qualified ?>-summary" - style="display: none;"> - <?cs call:write_attr_summary(cl.attrs) ?> + <div id="inherited-attrs-<?cs var:cl.qualified ?>-summary" style="display: none;"> + <table class="jd-sumtable-expando"> + <?cs call:write_attr_summary(cl.attrs) ?></table> </div> </div> +</td></tr> <?cs /if ?> <?cs /each ?> - - +</table> +<?cs /if ?> <?cs if:subcount(class.enumConstants) ?> <?cs # this next line must be exactly like this to be parsed by eclipse ?> <!-- =========== ENUM CONSTANT SUMMARY =========== --> -<h3>Enum Values</h3> +<table id="enumconstants" class="jd-sumtable"><tr><th colspan="12">Enum Values</th></tr> <?cs set:count = #1 ?> -<table class="jd-linktable"> <?cs each:field=class.enumConstants ?> <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> > <td class="jd-descrcol"><?cs call:type_link(field.type) ?> </td> @@ -228,109 +323,129 @@ function toggle_inherited(base) { </tr> <?cs set:count = count + #1 ?> <?cs /each ?> -</table> <?cs /if ?> <?cs if:subcount(class.constants) ?> <?cs # this next line must be exactly like this to be parsed by eclipse ?> <!-- =========== FIELD SUMMARY =========== --> -<h3>Constants</h3> +<table id="constants" class="jd-sumtable"><tr><th colspan="12">Constants</th></tr> <?cs call:write_constant_summary(class.constants) ?> +</table> <?cs /if ?> +<?cs # if there are inherited constants, write the table ?> +<?cs if:inhconstants ?> +<table id="inhconstants" class="jd-sumtable"><tr><th> + <div class="expandall">[<a href="">Expand All</a>]</div> + <div style="clear:left;">Inherited Constants</div></th></tr> <?cs each:cl=class.inherited ?> <?cs if:subcount(cl.constants) ?> -<h4><?cs call:expando_trigger("inherited-constants-"+cl.qualified, "closed") ?>Constants inherited - from <?cs var:cl.kind ?> - <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a> -</h4> +<tr><td colspan="12"> +<?cs call:expando_trigger("inherited-constants-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?> +<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a> <div id="inherited-constants-<?cs var:cl.qualified ?>"> -<div id="inherited-constants-<?cs var:cl.qualified ?>-list" + <div id="inherited-constants-<?cs var:cl.qualified ?>-list" class="jd-inheritedlinks"> - -</div> -<div id="inherited-constants-<?cs var:cl.qualified ?>-summary" - style="display: none;"> -<?cs call:write_constant_summary(cl.constants) ?> -</div> + </div> + <div id="inherited-constants-<?cs var:cl.qualified ?>-summary" style="display: none;"> + <table class="jd-sumtable-expando"> + <?cs call:write_constant_summary(cl.constants) ?></table> + </div> </div> +</td></tr> <?cs /if ?> <?cs /each ?> - +</table> +<?cs /if ?> <?cs if:subcount(class.fields) ?> <?cs # this next line must be exactly like this to be parsed by eclipse ?> <!-- =========== FIELD SUMMARY =========== --> -<h3>Fields</h3> +<table id="lfields" class="jd-sumtable"><tr><th colspan="12">Fields</th></tr> <?cs call:write_field_summary(class.fields) ?> +</table> <?cs /if ?> +<?cs # if there are inherited fields, write the table ?> +<?cs if:inhfields ?> +<table id="inhfields" class="jd-sumtable"><tr><th> + <div class="expandall">[<a href="">Expand All</a>]</div> + <div style="clear:left;">Inherited Fields</div></th></tr> <?cs each:cl=class.inherited ?> <?cs if:subcount(cl.fields) ?> -<h4><?cs call:expando_trigger("inherited-fields-"+cl.qualified, "closed") ?>Fields inherited - from <?cs var:cl.kind ?> - <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a> -</h4> +<tr><td colspan="12"> +<?cs call:expando_trigger("inherited-fields-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?> +<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a> <div id="inherited-fields-<?cs var:cl.qualified ?>"> -<div id="inherited-fields-<?cs var:cl.qualified ?>-list" + <div id="inherited-fields-<?cs var:cl.qualified ?>-list" class="jd-inheritedlinks"> - -</div> -<div id="inherited-fields-<?cs var:cl.qualified ?>-summary" - style="display: none;"> -<?cs call:write_field_summary(cl.fields) ?> -</div> + </div> + <div id="inherited-fields-<?cs var:cl.qualified ?>-summary" style="display: none;"> + <table class="jd-sumtable-expando"> + <?cs call:write_field_summary(cl.fields) ?></table> + </div> </div> +</td></tr> <?cs /if ?> <?cs /each ?> - +</table> +<?cs /if ?> <?cs if:subcount(class.ctors.public) ?> <?cs # this next line must be exactly like this to be parsed by eclipse ?> <!-- ======== CONSTRUCTOR SUMMARY ======== --> -<h3>Public Constructors</h3> +<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr> <?cs call:write_method_summary(class.ctors.public) ?> +</table> <?cs /if ?> <?cs if:subcount(class.ctors.protected) ?> <?cs # this next line must be exactly like this to be parsed by eclipse ?> <!-- ======== CONSTRUCTOR SUMMARY ======== --> -<h3>Protected Constructors</h3> +<table id="proctors" class="jd-sumtable"><tr><th colspan="12">Protected Constructors</th></tr> <?cs call:write_method_summary(class.ctors.protected) ?> +</table> <?cs /if ?> <?cs if:subcount(class.methods.public) ?> <?cs # this next line must be exactly like this to be parsed by eclipse ?> <!-- ========== METHOD SUMMARY =========== --> -<h3>Public Methods</h3> +<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr> <?cs call:write_method_summary(class.methods.public) ?> +</table> <?cs /if ?> <?cs if:subcount(class.methods.protected) ?> <?cs # this next line must be exactly like this to be parsed by eclipse ?> <!-- ========== METHOD SUMMARY =========== --> -<h3>Protected Methods</h3> +<table id="promethods" class="jd-sumtable"><tr><th colspan="12">Protected Methods</th></tr> <?cs call:write_method_summary(class.methods.protected) ?> +</table> <?cs /if ?> +<?cs # if there are inherited methods, write the table ?> +<?cs if:inhmethods ?> +<table id="inhmethods" class="jd-sumtable"><tr><th> + <div class="expandall">[<a href="">Expand All</a>]</div> + <div style="clear:left;">Inherited Methods</div></th></tr> <?cs each:cl=class.inherited ?> <?cs if:subcount(cl.methods) ?> -<h4><?cs call:expando_trigger("inherited-methods-"+cl.qualified, "closed") ?>Methods inherited - from <?cs var:cl.kind ?> - <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a> -</h4> +<tr><td colspan="12"><?cs call:expando_trigger("inherited-methods-"+cl.qualified, "closed") ?> +From <?cs var:cl.kind ?> <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a> <div id="inherited-methods-<?cs var:cl.qualified ?>"> -<div id="inherited-methods-<?cs var:cl.qualified ?>-list" + <div id="inherited-methods-<?cs var:cl.qualified ?>-list" class="jd-inheritedlinks"> - -</div> -<div id="inherited-methods-<?cs var:cl.qualified ?>-summary" - style="display: none;"> -<?cs call:write_method_summary(cl.methods) ?> -</div> + </div> + <div id="inherited-methods-<?cs var:cl.qualified ?>-summary" style="display: none;"> + <table class="jd-sumtable-expando"> + <?cs call:write_method_summary(cl.methods) ?></table> + </div> </div> +</td></tr> <?cs /if ?> <?cs /each ?> +</table> +<?cs /if ?> </div><!-- jd-descr (summary) --> @@ -381,7 +496,8 @@ function toggle_inherited(base) { <?cs var:method.synchronized ?> <?cs call:type_link(method.returnType) ?> </span> - <?cs var:method.name ?>(<?cs call:parameter_list(method.params) ?>) + <span class="sympad"><?cs var:method.name ?></span> + <span class="normal">(<?cs call:parameter_list(method.params) ?>)</span> </h4> <div class="jd-details-descr"><?cs call:description(method) ?></div> </div> |