Package uk.ac.starlink.ttools.build
Class HandlerDoc
java.lang.Object
uk.ac.starlink.ttools.build.HandlerDoc
Writes auto-generated documentation XML files for STIL I/O handlers.
- Since:
- 21 Sep 2020
- Author:
- Mark Taylor
-
Constructor Summary
ConstructorsConstructorDescriptionHandlerDoc
(uk.ac.starlink.table.StarTableFactory tfact, uk.ac.starlink.table.StarTableOutput tout, uk.ac.starlink.table.StarTable exampleTable) Constructor. -
Method Summary
Modifier and TypeMethodDescriptiongetBuilderDoc
(uk.ac.starlink.table.TableBuilder builder) Returns the XML documentation for a given STIL input handler.getWriterDoc
(uk.ac.starlink.table.StarTableWriter writer) Returns the XML documentation for a given STIL output handler.static void
Writes documentation for all handlers.
-
Constructor Details
-
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 Details
-
getBuilderDoc
Returns the XML documentation for a given STIL input handler.- Parameters:
builder
- input handler- Returns:
- XML documentation string
- Throws:
IOException
-
getWriterDoc
Returns the XML documentation for a given STIL output handler.- Parameters:
writer
- output handler- Returns:
- XML documentation string
- Throws:
IOException
-
main
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:
IOException
-