Enumerated types are working.

This commit is contained in:
Mark DePristo 2011-07-24 18:14:21 -04:00
parent 3c34e9fa65
commit 83996f7951
4 changed files with 35 additions and 51 deletions

View File

@ -154,9 +154,13 @@ public class GATKRunReport {
private long nReads; private long nReads;
public enum PhoneHomeOption { public enum PhoneHomeOption {
/** Disable phone home */
NO_ET, NO_ET,
/** Standard option. Writes to local repository if it can be found, or S3 otherwise */
STANDARD, STANDARD,
/** Force output to STDOUT. For debugging only */
STDOUT, STDOUT,
/** Force output to S3. For debugging only */
AWS_S3 // todo -- remove me -- really just for testing purposes AWS_S3 // todo -- remove me -- really just for testing purposes
} }

View File

@ -221,10 +221,10 @@ public class GenericDocumentationHandler extends DocumentedGATKFeatureHandler {
protected Map<String, Object> docForArgument(FieldDoc fieldDoc, ArgumentSource source, ArgumentDefinition def) { protected Map<String, Object> docForArgument(FieldDoc fieldDoc, ArgumentSource source, ArgumentDefinition def) {
Map<String, Object> root = new HashMap<String, Object>(); Map<String, Object> root = new HashMap<String, Object>();
root.put("name", def.fullName != null ? "--" + def.fullName : "-" + def.shortName); root.put("name", def.shortName != null ? "-" + def.shortName : "--" + def.fullName );
if ( def.fullName != null && def.shortName != null) if ( def.shortName != null && def.fullName != null )
root.put("synonyms", def.fullName != null ? "--" + def.fullName : "-" + def.shortName); root.put("synonyms", "--" + def.fullName);
root.put("required", def.required ? "yes" : "no"); root.put("required", def.required ? "yes" : "no");
root.put("type", def.argumentType.getSimpleName()); root.put("type", def.argumentType.getSimpleName());

View File

@ -2,11 +2,10 @@
<#macro argumentlist name myargs> <#macro argumentlist name myargs>
<#if myargs?size != 0> <#if myargs?size != 0>
<tr><th colspan="4"><b>${name}</b></th></tr> <tr><th colspan="3" id="row-divider">${name}</th></tr>
<#list myargs as arg> <#list myargs as arg>
<tr> <tr>
<td><a href="#${arg.name}">${arg.name}</a></td> <td><a href="#${arg.name}">${arg.name}</a></td>
<td><a href="#${arg.name}">${arg.synonyms!""}</a></td>
<td>${arg.type}</td> <td>${arg.type}</td>
<td>${arg.summary}</td> <td>${arg.summary}</td>
</tr> </tr>
@ -22,7 +21,7 @@
(<#if arg.attributes??>${arg.attributes} </#if>${arg.type})</h3> (<#if arg.attributes??>${arg.attributes} </#if>${arg.type})</h3>
${arg.summary}. ${arg.fulltext}<br> ${arg.summary}. ${arg.fulltext}<br>
<#if arg.options??> <#if arg.options??>
<p>The ${arg.name} argument can have one of the following values:</p> <p>The ${arg.name} argument is an enumerated type (${arg.type}), which can have one of the following values:</p>
<dl class="enum"> <dl class="enum">
<#list arg.options as option> <#list arg.options as option>
<dt>${option.name} <dt>${option.name}
@ -70,7 +69,6 @@
<thead> <thead>
<tr> <tr>
<th>Name</th> <th>Name</th>
<th>Synonyms</th>
<th>Type</th> <th>Type</th>
<th>Summary</th> <th>Summary</th>
</tr> </tr>

View File

@ -19,47 +19,12 @@ p.version, p.see-also
font-size: 8pt; font-size: 8pt;
} }
dl.enum
{
margin: 0em 0;
padding: 0;
}
.enum dt
{
position: relative;
left: 0;
top: 1.1em;
width: 5em;
font-weight: bold;
}
.enum dd
{
border-left: 1px solid #000;
margin: 0 0 0 6em;
padding: 0 0 .5em .5em;
}
/*
a
{
color: #546188;
text-decoration: none;
}
a:visited
{
color: #546188;
}
*/
h1, h2, h3 h1, h2, h3
{ {
font-family: Corbel, Arial, Helvetica, Sans-Serif; font-family: Corbel, Arial, Helvetica, Sans-Serif;
font-weight: bold; font-weight: bold;
text-align: left; text-align: left;
color: #bac8da; color: #669;
} }
h1 h1
@ -74,16 +39,27 @@ h3
font-weight: normal; font-weight: normal;
} }
table.indextable tr td /*
{ * enum DT layout
margin-right: 1em; */
dl {
border: 1px solid #ccc;
}
dt {
font-weight: bold;
text-decoration: underline;
}
dd {
margin: 0;
padding: 0 0 0.5em 0;
} }
/* /*
Blue Dream * clean table layouts
Written by Teylor Feliz http://www.admixweb.com
*/ */
#hor-minimalist-b #hor-minimalist-b
{ {
font-family: "Lucida Sans Unicode", "Lucida Grande", Sans-Serif; font-family: "Lucida Sans Unicode", "Lucida Grande", Sans-Serif;
@ -112,3 +88,9 @@ table.indextable tr td
{ {
color: #009; color: #009;
} }
th#row-divider
{
font-weight: bolder;
font-size: larger;
}