Package uk.ac.starlink.ttools.build

Class UsageWriterMan

  • public class UsageWriterMan
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      UsageWriterMan()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String formatXML​(java.lang.String xml)  
      static java.lang.String formatXML​(org.w3c.dom.Node doc)  
      static java.lang.String getStiltsOptions​(org.w3c.dom.Document doc)  
      static java.lang.String getStiltsSynopsis()  
      static java.lang.String getStiltsTasks​(java.lang.String[] taskNames)  
      static java.lang.String getTaskDescription​(java.lang.String taskName, org.w3c.dom.Document doc)  
      static java.lang.String getTaskOptions​(uk.ac.starlink.task.Task task)  
      static java.lang.String getTaskSynopsis​(java.lang.String taskName, uk.ac.starlink.task.Task task)  
      static void main​(java.lang.String[] args)  
      static java.lang.String manPage​(java.lang.String[] taskNames, org.w3c.dom.Document doc)  
      static java.lang.String manPage​(java.lang.String taskName, org.w3c.dom.Document doc)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • UsageWriterMan

        public UsageWriterMan()

    • Method Detail

      • manPage

        public static java.lang.String manPage​(java.lang.String taskName,
                                       org.w3c.dom.Document doc)
                                throws java.io.IOException,
                                       org.xml.sax.SAXException,
                                       uk.ac.starlink.util.LoadException,
                                       javax.xml.parsers.ParserConfigurationException
        Throws:
        java.io.IOException
        org.xml.sax.SAXException
        uk.ac.starlink.util.LoadException
        javax.xml.parsers.ParserConfigurationException

      • getTaskSynopsis

        public static java.lang.String getTaskSynopsis​(java.lang.String taskName,
                                               uk.ac.starlink.task.Task task)

      • getTaskOptions

        public static java.lang.String getTaskOptions​(uk.ac.starlink.task.Task task)
                                       throws org.xml.sax.SAXException,
                                              java.io.IOException,
                                              javax.xml.parsers.ParserConfigurationException
        Throws:
        org.xml.sax.SAXException
        java.io.IOException
        javax.xml.parsers.ParserConfigurationException

      • getTaskDescription

        public static java.lang.String getTaskDescription​(java.lang.String taskName,
                                                  org.w3c.dom.Document doc)

      • manPage

        public static java.lang.String manPage​(java.lang.String[] taskNames,
                                       org.w3c.dom.Document doc)
                                throws uk.ac.starlink.util.LoadException
        Throws:
        uk.ac.starlink.util.LoadException

      • getStiltsSynopsis

        public static java.lang.String getStiltsSynopsis()

      • getStiltsOptions

        public static java.lang.String getStiltsOptions​(org.w3c.dom.Document doc)

      • getStiltsTasks

        public static java.lang.String getStiltsTasks​(java.lang.String[] taskNames)
                                       throws uk.ac.starlink.util.LoadException
        Throws:
        uk.ac.starlink.util.LoadException

      • formatXML

        public static java.lang.String formatXML​(java.lang.String xml)
                                  throws org.xml.sax.SAXException,
                                         java.io.IOException,
                                         javax.xml.parsers.ParserConfigurationException
        Throws:
        org.xml.sax.SAXException
        java.io.IOException
        javax.xml.parsers.ParserConfigurationException

      • formatXML

        public static java.lang.String formatXML​(org.w3c.dom.Node doc)

      • main

        public static void main​(java.lang.String[] args)
                 throws java.io.IOException,
                        uk.ac.starlink.util.LoadException,
                        org.xml.sax.SAXException,
                        javax.xml.parsers.ParserConfigurationException
        Throws:
        java.io.IOException
        uk.ac.starlink.util.LoadException
        org.xml.sax.SAXException
        javax.xml.parsers.ParserConfigurationException