Merge "Update macros as needed for rewrite of templates that make them re-usable on both DAC and DevSite Depends on CL in build/tools/" into mnc-docs
diff --git a/res/assets/templates/macros.cs b/res/assets/templates/macros.cs
index 16711c4..bdb2b2b 100644
--- a/res/assets/templates/macros.cs
+++ b/res/assets/templates/macros.cs
@@ -1,9 +1,11 @@
-<?cs # A link to a package ?><?cs
+<?cs # A link to a package ?><?cs
def:package_link(pkg) ?>
- <a href="<?cs var:toroot ?><?cs var:pkg.link ?>"><?cs var:pkg.name ?></a><?cs
+ <a href="<?cs var:toroot ?><?cs var:pkg.link ?>"><?cs var:pkg.name ?></a><?cs
/def ?>
-<?cs # A link to a type, or not if it's a primitive type
+
+
+<?cs # A link to a type, or not if it is a primitive type
link: whether to create a link at the top level, always creates links in
recursive invocations.
Overloaded version to support use of 'nav' parameter, which when true,
@@ -15,16 +17,16 @@
.superBounds.N.(more links) (... super ... & ...)
.extendsBounds.N.(more links) (... extends ... & ...)
.typeArguments.N.(more links) (< ... >)
-?><?cs
+?><?cs
def:type_link_impl(type, link) ?><?cs call:type_link_impl2(type, link, "false") ?><?cs /def ?><?cs
def:type_link_impl2(type, link, nav) ?><?cs
if:type.link && link=="true" ?><?cs
if:type.federated ?><a href="<?cs var:type.link ?>"><?cs
- var:type.label ?></a><?cs
+ var:type.label ?></a><?cs
else ?><a href="<?cs var:toroot ?><?cs var:type.link ?>"><?cs var:type.label ?></a><?cs
/if ?><?cs
else ?><?cs var:type.label ?><?cs
- /if ?><?cs
+ /if ?><?cs
if:subcount(type.extendsBounds) ?><?cs
each:t=type.extendsBounds ?><?cs
if:first(t) ?> extends <?cs else ?> & <?cs /if ?><?cs
@@ -73,16 +75,7 @@
if:condition ?><a href="<?cs var:root ?><?cs var:path ?>"><?cs /if ?><?cs var:text ?><?cs if:condition ?></a><?cs /if ?><?cs
/def ?>
-<?cs # A comma separated parameter list ?><?cs
-def:parameter_list(params) ?><?cs
- each:param = params ?><?cs
- call:simple_type_link(param.type)?> <?cs
- var:param.name ?><?cs
- if: name(param)!=subcount(params)-1?>, <?cs /if ?><?cs
- /each ?><?cs
-/def ?>
-
-<?cs # Print a list of tags (e.g. description text ?><?cs
+<?cs # Print a list of tags (e.g. description text ?><?cs
def:tag_list(tags) ?><?cs
each:tag = tags ?><?cs
if:tag.name == "Text" ?><?cs var:tag.text?><?cs
@@ -119,14 +112,14 @@
elif:tag.kind == "@adtZipBytes" ?><?cs var:adt.zip.bytes ?><?cs
elif:tag.kind == "@adtZipChecksum" ?><?cs var:adt.zip.checksum ?><?cs
elif:tag.kind == "@inheritDoc" ?><?cs # This is the case when @inheritDoc is in something
- that doesn't inherit from anything?><?cs
+ that does not inherit from anything?><?cs
elif:tag.kind == "@attr" ?><?cs
else ?>{<?cs var:tag.name?> <?cs var:tag.text ?>}<?cs
/if ?><?cs
/each ?><?cs
/def ?>
-<?cs # Show the short-form description of something. These come from shortDescr and deprecated ?><?cs
+<?cs # Show the short-form description of something. These come from shortDescr and deprecated ?><?cs
def:short_descr(obj) ?><?cs
if:subcount(obj.deprecated) ?><em><?cs
if:obj.deprecatedsince ?>
@@ -179,7 +172,7 @@
call:show_annotations_list(obj, pre, ", ", post) ?><?cs
/def ?>
-<?cs # Show the red box with the deprecated warning ?><?cs
+<?cs # Show the red box with the deprecated warning ?><?cs
def:deprecated_warning(obj) ?><?cs
if:subcount(obj.deprecated) ?><p>
<p class="caution"><strong><?cs
@@ -194,22 +187,22 @@
/if ?><?cs
/def ?>
-<?cs # print the See Also: section ?><?cs
-def:see_also_tags(also) ?><?cs
+<?cs # print the See Also: section ?><?cs
+def:see_also_tags(also) ?><?cs
if:subcount(also) ?>
- <div class="jd-tagdata">
- <h5 class="jd-tagtitle">See Also</h5>
- <ul class="nolist"><?cs
+ <div>
+ <p><b>See also:</b></p>
+ <ul class="nolist"><?cs
each:tag=also ?><li><?cs
if:tag.kind == "@see" ?><code><a href="<?cs var:toroot ?><?cs var:tag.href ?>"><?cs
var:tag.label ?></a></code><?cs
elif:tag.kind == "@seeHref" ?><a href="<?cs var:tag.href ?>"><?cs var:tag.label ?></a><?cs
elif:tag.kind == "@seeJustLabel" ?><?cs var:tag.label ?><?cs
else ?>[ERROR: Unknown @see kind]<?cs
- /if ?></li><?cs
+ /if ?></li><?cs
/each ?>
</ul>
- </div><?cs
+ </div><?cs
/if ?>
<?cs /def ?>
@@ -222,124 +215,173 @@
<?cs def:federated_refs(obj) ?>
<?cs if:subcount(obj.federated) ?>
<div>
- Also:
+ Also:
<?cs each:federated=obj.federated ?>
- <a href="<?cs var:federated.url ?>"><?cs var:federated.name ?></a><?cs
+ <a href="<?cs var:federated.url ?>"><?cs var:federated.name ?></a><?cs
if:!last(federated) ?>,<?cs /if ?>
<?cs /each ?>
</div>
<?cs /if ?>
<?cs /def ?>
-<?cs # Print the long-form description for something.
- Uses the following fields: deprecated descr seeAlso since ?><?cs
-def:description(obj) ?><?cs
+<?cs
+#
+# Print the long-form description for something.
+# Uses the following fields: deprecated descr seeAlso since
+#
+?><?cs
+def:description(obj) ?><?cs
call:deprecated_warning(obj) ?>
- <div class="jd-tagdata jd-tagdescr"><p><?cs call:tag_list(obj.descr) ?></p></div><?cs
+ <p><?cs call:tag_list(obj.descr) ?></p><?cs
if:subcount(obj.annotationdocumentation)?><?cs
each:annodoc=obj.annotationdocumentation ?>
- <div class="jd-tagdata" style="display:block"><?cs var:annodoc.text?></div><?cs
+ <div style="display:block"><?cs var:annodoc.text?></div><?cs
/each?><?cs /if?><?cs
if:subcount(obj.attrRefs) ?>
- <div class="jd-tagdata">
- <h5 class="jd-tagtitle">Related XML Attributes</h5>
- <ul class="nolist"><?cs
+ <p><b>Related XML Attributes:</b></p>
+ <ul class="nolist"><?cs
each:attr=obj.attrRefs ?>
- <li><a href="<?cs var:toroot ?><?cs var:attr.href ?>"><?cs var:attr.name ?></a></li><?cs
+ <li><a href="<?cs var:toroot ?><?cs var:attr.href ?>"><?cs var:attr.name ?></a></li><?cs
/each ?>
</ul>
- </div><?cs
- /if ?><?cs
+ <?cs
+ /if ?><?cs
+ #
+ # Print the @param tags
+ #
+ ?><?cs
if:subcount(obj.paramTags) ?>
- <div class="jd-tagdata">
- <h5 class="jd-tagtitle">Parameters</h5>
- <table class="jd-tagtable"><?cs
- each:tag=obj.paramTags ?>
+ <table class="responsive">
+ <tr><th colspan=2>Parameters</th></tr><?cs
+ each:param=obj.paramTags ?>
+ <tr>
+ <td><code><?cs
+ if:param.isTypeParameter ?><<?cs
+ /if ?><?cs var:param.name ?><?cs
+ if:param.isTypeParameter ?>><?cs
+ /if ?></code></td>
+ <td width="100%"><?cs call:tag_list(param.comment) ?></td>
+ </tr><?cs
+ /each ?>
+ </table><?cs
+ #
+ # If no param tags found, but there are known params, print those instead
+ #
+ ?><?cs
+ elif:subcount(obj.params) ?>
+ <table class="responsive">
+ <tr><th colspan=2>Parameters</th></tr><?cs
+ each:param = obj.params ?>
<tr>
- <th><?cs if:tag.isTypeParameter ?><<?cs /if ?><?cs var:tag.name
- ?><?cs if:tag.isTypeParameter ?>><?cs /if ?></td>
- <td><?cs call:tag_list(tag.comment) ?></td>
- </tr><?cs
+ <td><code><?cs
+ if:param.isTypeParameter ?><<?cs
+ /if ?><?cs var:param.name ?><?cs
+ if:param.isTypeParameter ?>><?cs
+ /if ?></code></td>
+ <td width="100%"><!-- no param description in source --></td>
+ </tr><?cs
/each ?>
- </table>
- </div><?cs
- /if ?><?cs
+ </table><?cs
+ /if ?><?cs
+ #
+ # Print the @return value
+ #
+ ?><?cs
if:subcount(obj.returns) ?>
- <div class="jd-tagdata">
- <h5 class="jd-tagtitle">Returns</h5>
- <ul class="nolist"><li><?cs call:tag_list(obj.returns) ?></li></ul>
- </div><?cs
- /if ?><?cs
+ <table class="responsive">
+ <tr><th colspan=2>Returns</th></tr>
+ <tr>
+ <td><code><?cs call:type_link(method.returnType) ?></code></td>
+ <td width="100%"><?cs call:tag_list(obj.returns) ?></td>
+ </tr>
+ </table><?cs
+ #
+ # If no return tag found, but there is a return type not 'void', print it
+ #
+ ?><?cs
+ elif:subcount(method.returnType) && method.returnType.label != 'void' ?>
+ <table class="responsive">
+ <tr><th colspan=2>Returns</th></tr>
+ <tr>
+ <td><code><?cs call:type_link(method.returnType) ?></code></td>
+ <td width="100%"><!-- no returns description in source --></td>
+ </tr>
+ </table><?cs
+ /if ?><?cs
+ #
+ # Print the throwables
+ #
+ ?><?cs
if:subcount(obj.throws) ?>
- <div class="jd-tagdata">
- <h5 class="jd-tagtitle">Throws</h5>
- <table class="jd-tagtable"><?cs
- each:tag=obj.throws ?>
+ <table class="responsive">
+ <tr><th colspan=2>Throws</th></tr><?cs
+ each:tag=obj.throws ?>
<tr>
- <th><?cs call:type_link(tag.type) ?></td>
- <td><?cs call:tag_list(tag.comment) ?></td>
- </tr><?cs
+ <td><code><?cs call:type_link(tag.type) ?></code></td>
+ <td width="100%"><?cs call:tag_list(tag.comment) ?></td>
+ </tr><?cs
/each ?>
</table>
- </div><?cs
- /if ?><?cs
+ <?cs
+ /if ?><?cs
call:see_also_tags(obj.seeAlso) ?><?cs
/def ?>
<?cs # A table of links to classes with descriptions, as in a package file or the nested classes ?><?cs
-def:class_link_table(classes) ?><?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) ?> </td>
+ <td><?cs call:type_link(cl.type) ?></td>
+ <td width="100%"><?cs call:short_descr(cl) ?> </td>
</tr><?cs set:count = count + #1 ?><?cs
/each ?>
- </table><?cs
+ </table><?cs
/def ?>
-<?cs # A list of links to classes, for use in the side navigation of classes when viewing a package (panel nav) ?><?cs
-def:class_link_list(label, classes) ?><?cs
+<?cs # A list of links to classes, for use in the side navigation of classes when viewing a package (panel nav) ?><?cs
+def:class_link_list(label, classes) ?><?cs
if:subcount(classes) ?>
<li><h2><?cs var:label ?></h2>
- <ul><?cs
+ <ul><?cs
each:cl=classes ?>
<li class="api apilevel-<?cs var:cl.type.since ?>"><?cs call:type_link2(cl.type,"true") ?></li><?cs
/each ?>
</ul>
- </li><?cs
- /if ?><?cs
+ </li><?cs
+ /if ?><?cs
/def ?>
-<?cs # A list of links to classes, for use in the side navigation of classes when viewing a class (panel nav) ?><?cs
-def:list(label, classes) ?><?cs
+<?cs # A list of links to classes, for use in the side navigation of classes when viewing a class (panel nav) ?><?cs
+def:list(label, classes) ?><?cs
if:subcount(classes) ?>
<li><h2><?cs var:label ?></h2>
- <ul><?cs
+ <ul><?cs
each:cl=classes ?>
<li class="<?cs if:class.name == cl.label?>selected <?cs /if ?>api apilevel-<?cs var:cl.since ?>"><?cs call:type_link2(cl,"true") ?></li><?cs
/each ?>
</ul>
- </li><?cs
- /if ?><?cs
+ </li><?cs
+ /if ?><?cs
/def ?>
-<?cs # A list of links to packages, for use in the side navigation of packages (panel nav) ?><?cs
-def:package_link_list(packages) ?><?cs
+<?cs # A list of links to packages, for use in the side navigation of packages (panel nav) ?><?cs
+def:package_link_list(packages) ?><?cs
each:pkg=packages ?>
- <li class="<?cs if:(class.package.name == pkg.name) || (package.name == pkg.name)?>selected <?cs /if ?>api apilevel-<?cs var:pkg.since ?>"><?cs call:package_link(pkg) ?></li><?cs
+ <li class="<?cs if:(class.package.name == pkg.name) || (package.name == pkg.name)?>selected <?cs /if ?>api apilevel-<?cs var:pkg.since ?>"><?cs call:package_link(pkg) ?></li><?cs
/each ?><?cs
/def ?>
-<?cs # An expando trigger ?><?cs
+<?cs # An expando trigger ?><?cs
def:expando_trigger(id, default) ?>
<a href="#" onclick="return toggleInherited(this, null)" id="<?cs var:id ?>" class="jd-expando-trigger closed"
- ><img id="<?cs var:id ?>-trigger"
- src="<?cs var:toroot ?>assets/images/triangle-<?cs var:default ?>.png"
- class="jd-expando-trigger-img" /></a><?cs
+ ><img height="34" id="<?cs var:id ?>-trigger"
+ src="<?cs var:toroot ?>assets/images/styles/disclosure_<?cs
+ if:default == 'closed' ?>down<?cs else ?>up<?cs /if ?>.png"
+ class="jd-expando-trigger-img" /></a><?cs
/def ?>
-<?cs # An expandable list of classes ?><?cs
+<?cs # An expandable list of classes ?><?cs
def:expandable_class_list(id, classes, default) ?>
<div id="<?cs var:id ?>">
<div id="<?cs var:id ?>-list"
@@ -365,10 +407,10 @@
</div>
<div id="<?cs var:id ?>-summary"
<?cs if:default != "summary" ?>style="display: none;"<?cs /if ?>
- ><?cs
+ ><?cs
call:class_link_table(classes) ?>
</div>
- </div><?cs
+ </div><?cs
/def ?>
<?cs include:"components.cs" ?>
