StrixOS/build
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Show annotation information in generated documentation

Browse Source 
Display the annotations used to override @hide for classes in packages
and methods in classes.

Bug: 16848303
Change-Id: I5599e6593613edbbe6a002d5d46a0a6561dec55a
This commit is contained in:
Jeff Arneson
2014-08-22 15:40:47 -07:00
parent 6b0441319a
commit 3a5cb1bd15
4 changed files with 48 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
tools/droiddoc/templates-sdk/macros_override.cs Normal file
View File

@@ -0,0 +1,35 @@
<?cs # Create a comma separated list of annotations on obj that were in showAnnotations in Doclava ?>
<?cs # pre is an HTML string to start the list, post is an HTML string to close the list ?>
<?cs # for example call:show_annotations_list(cl, "<td>Annotations: ", "</td>") ?>
<?cs # if obj has nothing on obj.showAnnotations, nothing will be output ?>
<?cs def:show_annotations_list(obj, pre, post) ?>
<?cs each:anno = obj.showAnnotations ?>
<?cs if:first(anno) ?>
<?cs var:pre ?>
<?cs /if ?>
@<?cs var:anno.type.label ?>
<?cs if:last(anno) == 0 ?>
, &nbsp;
<?cs /if ?>
<?cs if:last(anno)?>
<?cs var:post ?>
<?cs /if ?>
<?cs /each ?>
<?cs /def ?>
<?cs # Override default class_link_table to display annotations ?>
<?cs def:class_link_table(classes) ?>
<?cs set:count = #1 ?>
<table class="jd-sumtable-expando">
<?cs each:cl=classes ?>
<tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:cl.type.since ?>" >
<td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td>
<td class="jd-descrcol" width="100%">
<?cs call:short_descr(cl) ?>&nbsp;
<?cs call:show_annotations_list(cl, "<span class='annotation-message'>Included in documentation by the annotations: ", "</span>") ?>
</td>
</tr>
<?cs set:count = count + #1 ?>
<?cs /each ?>
</table>
<?cs /def ?>