Package uk.ac.starlink.ttools.build

Classes to assist with building the TTOOLS package.

See: Description

Interface Summary

Interface	Description
DocletOutput	Serializes text obtained from javadocs to some specific output format.
DocletOutput.DocVariable	Characterises a method parameter.

Class Summary

Class	Description
DocletUtil	Utility class containing API-independent helper functions for writing doclets.
FilterDoc	Writes a section of XML text documenting all the known ProcessingFilters.
HandlerDoc	Writes auto-generated documentation XML files for STIL I/O handlers.
Heading	Enumeration class describing the function categories used by the JEL-accessible methods.
HtmlDocletOutput	DocletOutput implementation for writing basic HTML, with one file per class, method and field.
JdkDoclet	Doclet for documenting user-visible JEL library classes, based on the jdk.javadoc.doclet API.
JdkDoclet.Html	Class for use with javadoc tool that writes MethodBrowser-friendly HTML output.
JdkDoclet.Xml	Class for use with javadoc tool that writes SUN-friendly XML output.
JupyterCell	Manages export of a list of lines to the JSON format used for serialization of Jupyter notebooks (.ipynb files).
JyStilts	Writes a Jython module which facilitates use of STILTS functionality from Jython.
LayersWriter	Write XML text describing LayerTypes available to given TypedPlot2Tasks.
LayerTypeDoc	Writes XML text documenting known plot2 LayerTypes.
MatcherUsage
MemberIdSet	Set of identifiers used for class members during documentation.
MiscDoc	Write some miscallaneous auto-documentation files for ingestion in the user document.
ModeDoc	Writes a section of XML text documenteding all the known ProcessingModes.
OutputCapture	Captures the output of a java main() method, wraps it in a CDATA marked section, and outputs it.
PaintModeDoc	Writes a section of XML text documenting all the known PaintModes.
Plot2Example	Instances of this class represent a given figure plotted using the plot2 plotting classes and some externally supplied data.
Plot2Notebook	Utility methods for writing JupyterNotebooks that can be used with the plot server.
PlotExample	Programmatically generates example text and images for STILTS plotting tasks.
PurposeWriter	Writes entity definitions for the purposes of all the known STILTS tasks.
SchemeDoc	Writes a section of XML text documenting the details of TableSchemes available within the STILTS application.
ShaderLegend	Generates a graphic in SVG format showing labelled colourmaps.
ShapeModeDoc	Writes XML text documenting known plot2 ShapeModes (shading modes).
SunDoclet	Doclet for documenting user-visible JEL classes, based on the com.sun.javadoc API.
SunDoclet.Html	Class for use with javadoc tool that writes MethodBrowser-friendly HTML output.
SunDoclet.Xml	Class for use with javadoc tool that writes SUN-friendly XML output.
UsageWriter	Write usage paragraphs specific to the STILTS tasks.
XmlDocletOutput	DocletOutput implementation for writing SUN-friendly XML.

Annotation Types Summary

Annotation Type	Description
HideDoc	Indicates that a class, method or field is to be excluded from the auto-documentation made available to application users.

Package uk.ac.starlink.ttools.build Description

Classes to assist with building the TTOOLS package. These classes are not required at runtime.