Package uk.ac.starlink.ttools.build
Class HandlerDoc
- java.lang.Object
-
- uk.ac.starlink.ttools.build.HandlerDoc
-
public class HandlerDoc extends java.lang.Object
Writes auto-generated documentation XML files for STIL I/O handlers.- Since:
- 21 Sep 2020
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description HandlerDoc(uk.ac.starlink.table.StarTableFactory tfact, uk.ac.starlink.table.StarTableOutput tout, uk.ac.starlink.table.StarTable exampleTable)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getBuilderDoc(uk.ac.starlink.table.TableBuilder builder)
Returns the XML documentation for a given STIL input handler.java.lang.String
getWriterDoc(uk.ac.starlink.table.StarTableWriter writer)
Returns the XML documentation for a given STIL output handler.static void
main(java.lang.String[] args)
Writes documentation for all handlers.
-
-
-
Constructor Detail
-
HandlerDoc
public HandlerDoc(uk.ac.starlink.table.StarTableFactory tfact, uk.ac.starlink.table.StarTableOutput tout, uk.ac.starlink.table.StarTable exampleTable)
Constructor.- Parameters:
tfact
- table factorytout
- table output controllerexampleTable
- example table for optional inclusion in serialized form in output XML
-
-
Method Detail
-
getBuilderDoc
public java.lang.String getBuilderDoc(uk.ac.starlink.table.TableBuilder builder) throws java.io.IOException
Returns the XML documentation for a given STIL input handler.- Parameters:
builder
- input handler- Returns:
- XML documentation string
- Throws:
java.io.IOException
-
getWriterDoc
public java.lang.String getWriterDoc(uk.ac.starlink.table.StarTableWriter writer) throws java.io.IOException
Returns the XML documentation for a given STIL output handler.- Parameters:
writer
- output handler- Returns:
- XML documentation string
- Throws:
java.io.IOException
-
main
public static void main(java.lang.String[] args) throws java.io.IOException
Writes documentation for all handlers. Depending on presence of "-[no]files" flag will write to standard output or to individual named files in the current directory. Run with -help for usage.- Throws:
java.io.IOException
-
-