diff --git a/build.xml b/build.xml index dcaafe322..51f39f7a3 100644 --- a/build.xml +++ b/build.xml @@ -457,8 +457,9 @@ - + diff --git a/public/java/src/org/broadinstitute/sting/gatk/walkers/Walker.java b/public/java/src/org/broadinstitute/sting/gatk/walkers/Walker.java index 24813f4c6..9f26c9286 100755 --- a/public/java/src/org/broadinstitute/sting/gatk/walkers/Walker.java +++ b/public/java/src/org/broadinstitute/sting/gatk/walkers/Walker.java @@ -32,7 +32,7 @@ import org.broadinstitute.sting.utils.GenomeLoc; import org.broadinstitute.sting.utils.baq.BAQ; import org.broadinstitute.sting.utils.collections.Pair; import org.broadinstitute.sting.utils.help.DocumentedGATKFeature; -import org.broadinstitute.sting.utils.help.WalkerDocumentationHandler; +import org.broadinstitute.sting.utils.help.GenericDocumentationHandler; import java.util.List; @@ -46,7 +46,7 @@ import java.util.List; @ReadFilters(MalformedReadFilter.class) @PartitionBy(PartitionType.NONE) @BAQMode(QualityMode = BAQ.QualityMode.OVERWRITE_QUALS, ApplicationTime = BAQ.ApplicationTime.ON_INPUT) -@DocumentedGATKFeature( handler = WalkerDocumentationHandler.class ) +@DocumentedGATKFeature( groupName = "GATK walkers" ) public abstract class Walker { final protected static Logger logger = Logger.getLogger(Walker.class); private GenomeAnalysisEngine toolkit; diff --git a/public/java/src/org/broadinstitute/sting/utils/help/DocumentedGATKFeature.java b/public/java/src/org/broadinstitute/sting/utils/help/DocumentedGATKFeature.java index 02a7707e6..a63869cad 100644 --- a/public/java/src/org/broadinstitute/sting/utils/help/DocumentedGATKFeature.java +++ b/public/java/src/org/broadinstitute/sting/utils/help/DocumentedGATKFeature.java @@ -36,5 +36,6 @@ import java.lang.annotation.*; @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface DocumentedGATKFeature { - Class handler(); + String groupName(); + Class handler() default GenericDocumentationHandler.class; } diff --git a/public/java/src/org/broadinstitute/sting/utils/help/DocumentedGATKFeatureHandler.java b/public/java/src/org/broadinstitute/sting/utils/help/DocumentedGATKFeatureHandler.java index e459e1543..fe3e56efe 100644 --- a/public/java/src/org/broadinstitute/sting/utils/help/DocumentedGATKFeatureHandler.java +++ b/public/java/src/org/broadinstitute/sting/utils/help/DocumentedGATKFeatureHandler.java @@ -49,6 +49,7 @@ import java.util.Map; */ public abstract class DocumentedGATKFeatureHandler { private GATKDoclet doclet; + private String groupName; protected RootDoc getRootDoc() { return this.doclet.rootDoc; @@ -64,7 +65,14 @@ public abstract class DocumentedGATKFeatureHandler { return ResourceBundleExtractorDoclet.getClassName(doc).replace(".", "_") + ".html"; } - public abstract String getGroupName(); + final public String getGroupName() { + return groupName; + } + + final public void setGroupName(String groupName) { + this.groupName = groupName; + } + public abstract String getTemplateName(ClassDoc doc) throws IOException; public abstract GATKDoclet.DocumentationData processOne(ClassDoc doc); } diff --git a/public/java/src/org/broadinstitute/sting/utils/help/GATKDoclet.java b/public/java/src/org/broadinstitute/sting/utils/help/GATKDoclet.java index e155923a5..81eaf632c 100644 --- a/public/java/src/org/broadinstitute/sting/utils/help/GATKDoclet.java +++ b/public/java/src/org/broadinstitute/sting/utils/help/GATKDoclet.java @@ -110,6 +110,7 @@ public class GATKDoclet extends ResourceBundleExtractorDoclet { List indexData = new ArrayList(); for ( ClassDoc doc : rootDoc.classes() ) { + System.out.printf("Considering %s%n", doc); DocumentedGATKFeatureHandler handler = getHandlerForClassDoc(doc); if ( handler != null && handler.shouldBeProcessed(doc) ) { DocumentationData docData = processDocumentationWithHandler(cfg, handler, doc); @@ -132,6 +133,7 @@ public class GATKDoclet extends ResourceBundleExtractorDoclet { if ( docClass.isAnnotationPresent(DocumentedGATKFeature.class) ) { DocumentedGATKFeature feature = docClass.getAnnotation(DocumentedGATKFeature.class); DocumentedGATKFeatureHandler handler = feature.handler().newInstance(); + handler.setGroupName(feature.groupName()); handler.setDoclet(this); return handler; } else { @@ -152,7 +154,7 @@ public class GATKDoclet extends ResourceBundleExtractorDoclet { private void processIndex(Configuration cfg, List indexData) throws IOException { /* Get or create a template */ - Template temp = cfg.getTemplate("walker.index.template.html"); + Template temp = cfg.getTemplate("generic.index.template.html"); /* Merge data-model with template */ Writer out = new OutputStreamWriter(new FileOutputStream(new File("testdoc/index.html"))); diff --git a/public/java/src/org/broadinstitute/sting/utils/help/WalkerDocumentationHandler.java b/public/java/src/org/broadinstitute/sting/utils/help/GenericDocumentationHandler.java similarity index 94% rename from public/java/src/org/broadinstitute/sting/utils/help/WalkerDocumentationHandler.java rename to public/java/src/org/broadinstitute/sting/utils/help/GenericDocumentationHandler.java index f9109db72..cab6c327d 100644 --- a/public/java/src/org/broadinstitute/sting/utils/help/WalkerDocumentationHandler.java +++ b/public/java/src/org/broadinstitute/sting/utils/help/GenericDocumentationHandler.java @@ -48,7 +48,7 @@ import java.util.Map; /** * */ -public class WalkerDocumentationHandler extends DocumentedGATKFeatureHandler { +public class GenericDocumentationHandler extends DocumentedGATKFeatureHandler { @Override public boolean shouldBeProcessed(ClassDoc doc) { try { @@ -59,17 +59,14 @@ public class WalkerDocumentationHandler extends DocumentedGATKFeatureHandler { } } - @Override - public String getGroupName() { return "GATK Walkers"; } - @Override public String getTemplateName(ClassDoc doc) throws IOException { - return "walker.template.html"; + return "generic.template.html"; } @Override public GATKDoclet.DocumentationData processOne(ClassDoc doc) { - System.out.printf("Walker class %s%n", doc); + System.out.printf("%s class %s%n", getGroupName(), doc); Map root = buildWalkerDataModel(doc); // Create the root hash return new GATKDoclet.DocumentationData(doc.name(), (String)root.get("summary"), root); } @@ -136,9 +133,9 @@ public class WalkerDocumentationHandler extends DocumentedGATKFeatureHandler { } private FieldDoc getFieldDoc(ClassDoc classDoc, String name, boolean primary) { - System.out.printf("Looking for %s in %s%n", name, classDoc.name()); + //System.out.printf("Looking for %s in %s%n", name, classDoc.name()); for ( FieldDoc fieldDoc : classDoc.fields(false) ) { - System.out.printf("fieldDoc " + fieldDoc + " name " + fieldDoc.name()); + //System.out.printf("fieldDoc " + fieldDoc + " name " + fieldDoc.name()); if ( fieldDoc.name().equals(name) ) return fieldDoc; diff --git a/settings/helpTemplates/walker.index.template.html b/settings/helpTemplates/generic.index.template.html similarity index 100% rename from settings/helpTemplates/walker.index.template.html rename to settings/helpTemplates/generic.index.template.html diff --git a/settings/helpTemplates/walker.template.html b/settings/helpTemplates/generic.template.html similarity index 100% rename from settings/helpTemplates/walker.template.html rename to settings/helpTemplates/generic.template.html