|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.build.UsageWriter
public class UsageWriter
Write usage paragraphs specific to the STILTS tasks.
This class is designed to be used from its main
method.
Method Summary | |
---|---|
static void |
main(String[] args)
Writes a file called taskname-summary.xml for each of the tasks in STILTS. |
static String |
xmlItem(Parameter param,
boolean isBasic)
Returns a list item (dt/dd pair) for a parameter giving its usage and description. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static String xmlItem(Parameter param, boolean isBasic)
param
- parameterisBasic
- if true, avoid adding XML constructs which won't be
evident (and may cause parsing trouble)
in plain text output
param
public static void main(String[] args) throws IOException, LoadException
IOException
LoadException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |