org.broadinstitute.hellbender.utils.help

Class GATKDocWorkUnit

java.lang.Object

org.broadinstitute.barclay.help.DocWorkUnit

org.broadinstitute.hellbender.utils.help.GATKDocWorkUnit

All Implemented Interfaces:

java.lang.Comparable<org.broadinstitute.barclay.help.DocWorkUnit>

public class GATKDocWorkUnit
extends org.broadinstitute.barclay.help.DocWorkUnit

Custom DocWorkUnit used for generating GATK help/documentation. Overrides the defaults to provide tool names that are annotated with a " (Picard)" suffix for Picard tools. NOTE: Methods in this class are intended to be called by Gradle/Javadoc only, and should not be called by methods that are used by the GATK runtime. This class has a dependency on com.sun.javadoc classes, which may not be present since they're not provided as part of the normal GATK runtime classpath.

Field Summary

Fields inherited from class org.broadinstitute.barclay.help.DocWorkUnit

groupName, groupSummary, logger, summary

Constructor Summary

Constructors

Constructor and Description
GATKDocWorkUnit(org.broadinstitute.barclay.help.DocWorkUnitHandler workUnitHandler, org.broadinstitute.barclay.help.DocumentedFeature documentedFeatureAnnotation, com.sun.javadoc.ClassDoc classDoc, java.lang.Class<?> clazz)

Method Summary

Modifier and Type	Method and Description
int	compareTo(org.broadinstitute.barclay.help.DocWorkUnit other) Sort in order of the name of this WorkUnit
java.lang.String	getName()

Methods inherited from class org.broadinstitute.barclay.help.DocWorkUnit

getClassDoc, getClazz, getCommandLineProgramGroup, getCommandLineProperties, getDocumentedFeature, getGroupName, getGroupSummary, getJSONFileName, getProperty, getRootMap, getSummary, getTargetFileName, getTemplateName, isBetaFeature, isExperimentalFeature, processDoc, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GATKDocWorkUnit

public GATKDocWorkUnit(org.broadinstitute.barclay.help.DocWorkUnitHandler workUnitHandler,
                       org.broadinstitute.barclay.help.DocumentedFeature documentedFeatureAnnotation,
                       com.sun.javadoc.ClassDoc classDoc,
                       java.lang.Class<?> clazz)

Method Detail

getName

public java.lang.String getName()

Overrides:

getName in class org.broadinstitute.barclay.help.DocWorkUnit

compareTo

public int compareTo(org.broadinstitute.barclay.help.DocWorkUnit other)

Sort in order of the name of this WorkUnit

Specified by:

compareTo in interface java.lang.Comparable<org.broadinstitute.barclay.help.DocWorkUnit>

Overrides:

compareTo in class org.broadinstitute.barclay.help.DocWorkUnit