uk.ac.starlink.ttools.build
Class UsageWriter

java.lang.Object
  extended by uk.ac.starlink.ttools.build.UsageWriter

public class UsageWriter
extends Object

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
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

xmlItem

public static String xmlItem(Parameter param,
                             boolean isBasic)
Returns a list item (dt/dd pair) for a parameter giving its usage and description.

Parameters:
param - parameter
isBasic - 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

public static void main(String[] args)
                 throws IOException,
                        LoadException
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
LoadException


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.