tequilaOS/platform_build
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Show annotation information for fields, enums, etc. and in the class list

Browse source 
Add the "Included in documentation due to annotations..." text for
fields, enum constants, and pretty much everything with a description.

Added annotation text to eh classes.cs file used to generate the
class list page.

Change-Id: I2685d1a34fa292088c03ccd76f2627fe954c9000
This commit is contained in:
Jeff Arneson 2014-09-10 17:20:33 -07:00
parent 0052f75f88
commit 9eefef66a8
2 changed files with 27 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
tools/droiddoc/templates-sdk/class.cs
View file

@ -215,7 +215,10 @@ Summary:
<?cs var:field.final ?> <?cs var:field.final ?>
<?cs call:type_link(field.type) ?></nobr></td> <?cs call:type_link(field.type) ?></nobr></td>
<td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, included) ?></td> <td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, included) ?></td>
<td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td> <td class="jd-descrcol" width="100%">
<?cs call:short_descr(field) ?>
<?cs call:show_annotations_list(field, "<span class='annotation-message'>Included in documentation by the annotations: ", "</span>") ?>
</td>
</tr> </tr>
<?cs set:count = count + #1 ?> <?cs set:count = count + #1 ?>
<?cs /each ?> <?cs /each ?>
@ -227,7 +230,10 @@ Summary:
<tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:field.since ?>" > <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:field.since ?>" >
<td class="jd-typecol"><?cs call:type_link(field.type) ?></td> <td class="jd-typecol"><?cs call:type_link(field.type) ?></td>
<td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, included) ?></td> <td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, included) ?></td>
<td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td> <td class="jd-descrcol" width="100%">
<?cs call:short_descr(field) ?>
<?cs call:show_annotations_list(field, "<span class='annotation-message'>Included in documentation by the annotations: ", "</span>") ?>
</td>
</tr> </tr>
<?cs set:count = count + #1 ?> <?cs set:count = count + #1 ?>
<?cs /each ?> <?cs /each ?>
@ -247,7 +253,10 @@ Summary:
<?cs call:cond_link(m.name, toroot, m.href, included) ?> <?cs call:cond_link(m.name, toroot, m.href, included) ?>
<?cs /each ?> <?cs /each ?>
</td> </td>
<td class="jd-descrcol" width="100%"><?cs call:short_descr(attr) ?>&nbsp;</td> <td class="jd-descrcol" width="100%">
<?cs call:short_descr(attr) ?>&nbsp;
<?cs call:show_annotations_list(attr, "<span class='annotation-message'>Included in documentation by the annotations: ", "</span>") ?>
</td>
</tr> </tr>
<?cs set:count = count + #1 ?> <?cs set:count = count + #1 ?>
<?cs /each ?> <?cs /each ?>
@ -264,7 +273,10 @@ Summary:
<?cs var:cl.abstract ?> <?cs var:cl.abstract ?>
<?cs var:cl.kind ?></nobr></td> <?cs var:cl.kind ?></nobr></td>
<td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td> <td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td>
<td class="jd-descrcol" width="100%"><?cs call:short_descr(cl) ?>&nbsp;</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> </tr>
<?cs set:count = count + #1 ?> <?cs set:count = count + #1 ?>
<?cs /each ?> <?cs /each ?>
@ -340,7 +352,10 @@ Summary:
<tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:field.since ?>" > <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:field.since ?>" >
<td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td> <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
<td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, cl.included) ?>&nbsp;</td> <td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, cl.included) ?>&nbsp;</td>
<td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?>&nbsp;</td> <td class="jd-descrcol" width="100%">
<?cs call:short_descr(field) ?>&nbsp;
<?cs call:show_annotations_list(field, "<span class='annotation-message'>Included in documentation by the annotations: ", "</span>") ?>
</td>
</tr> </tr>
<?cs set:count = count + #1 ?> <?cs set:count = count + #1 ?>
<?cs /each ?> <?cs /each ?>
@ -509,6 +524,7 @@ From <?cs var:cl.kind ?>
<?cs call:federated_refs(field) ?> <?cs call:federated_refs(field) ?>
</div> </div>
<div class="jd-details-descr"> <div class="jd-details-descr">
<?cs call:show_annotations_list(field, "<span class='annotation-message'>Included in documentation by the annotations: ", "</span>") ?>
<?cs call:description(field) ?> <?cs call:description(field) ?>
<?cs if:subcount(field.constantValue) ?> <?cs if:subcount(field.constantValue) ?>
<div class="jd-tagdata"> <div class="jd-tagdata">
@ -566,6 +582,7 @@ From <?cs var:cl.kind ?>
<h4 class="jd-details-title"><?cs var:attr.name ?> <h4 class="jd-details-title"><?cs var:attr.name ?>
</h4> </h4>
<div class="jd-details-descr"> <div class="jd-details-descr">
<?cs call:show_annotations_list(attr, "<span class='annotation-message'>Included in documentation by the annotations: ", "</span>") ?>
<?cs call:description(attr) ?> <?cs call:description(attr) ?>
<div class="jd-tagdata"> <div class="jd-tagdata">

6
tools/droiddoc/templates-sdk/classes.cs
View file

@ -1,5 +1,6 @@
<?cs include:"doctype.cs" ?> <?cs include:"doctype.cs" ?>
<?cs include:"macros.cs" ?> <?cs include:"macros.cs" ?>
<?cs include:"macros_override.cs" ?>
<html<?cs if:devsite ?> devsite<?cs /if ?>> <html<?cs if:devsite ?> devsite<?cs /if ?>>
<?cs include:"head_tag.cs" ?> <?cs include:"head_tag.cs" ?>
<body class="gc-documentation <?cs if:(reference.gms || reference.gcm) ?>google<?cs /if ?> <body class="gc-documentation <?cs if:(reference.gms || reference.gcm) ?>google<?cs /if ?>
@ -30,7 +31,10 @@
<?cs each:cl = letter ?> <?cs each:cl = letter ?>
<tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:cl.since ?>" > <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:cl.since ?>" >
<td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td> <td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td>
<td class="jd-descrcol" width="100%"><?cs call:short_descr(cl) ?>&nbsp;</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> </tr>
<?cs set:count = count + #1 ?> <?cs set:count = count + #1 ?>
<?cs /each ?> <?cs /each ?>