Package uk.ac.starlink.ttools.build
Class UsageWriter
java.lang.Object
uk.ac.starlink.ttools.build.UsageWriter
Write usage paragraphs specific to the STILTS tasks.
This class is designed to be used from its
main
method.- Since:
- 17 Aug 2005
- Author:
- Mark Taylor
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
Writes a file called taskname-summary.xml for each of the tasks in STILTS.static String
Returns a list item (dt/dd pair) for a parameter giving its usage and description.
-
Method Details
-
xmlItem
public static String xmlItem(uk.ac.starlink.task.Parameter<?> param, String baseId, boolean isBasic) Returns a list item (dt/dd pair) for a parameter giving its usage and description.If a non-null
baseId
is supplied, the outputdt
element is written with an id attribute of the formbaseId-paramName
.- Parameters:
param
- parameterbaseId
- prefix to parameter name for use in generating id attribute, or null for no idisBasic
- if true, avoid adding XML constructs which won't be evident (and may cause parsing trouble) in plain text output- Returns:
- XML snippet for
param
-
main
Writes a file called taskname-summary.xml for each of the tasks in STILTS. This contains a basic usage summary with some surrounding XML boilerplate.- Throws:
IOException
uk.ac.starlink.util.LoadException
-