Package uk.ac.starlink.ttools.build
Class XmlDocletOutput
java.lang.Object
uk.ac.starlink.ttools.build.XmlDocletOutput
- All Implemented Interfaces:
DocletOutput
DocletOutput implementation for writing SUN-friendly XML.
The output is intended to be inserted into TOPCAT/STILTS user
documents to document the user-visible expressions in the JEL
expression language.
- Since:
- 24 Jan 2023
- Author:
- Mark Taylor
-
Nested Class Summary
Nested classes/interfaces inherited from interface uk.ac.starlink.ttools.build.DocletOutput
DocletOutput.DocVariable
-
Constructor Summary
ConstructorsConstructorDescriptionXmlDocletOutput
(OutputStream out, boolean headOnly, Function<String, String> clazzToId) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
endClass()
End output of documentation for the most recently started class.void
End output of the most recently started member.void
Called at the end of operation.void
outExamples
(String heading, String[] examples) Writes one or more example entries.void
outMemberItem
(String name, String val) This information is discarded; the XML output is too terse to include it.void
outParameters
(DocletOutput.DocVariable[] params) Writes a description of the parameters of a method.void
Writes information about the return value of a method.void
Writes one or more See Also entries.void
startClass
(String className, String firstSentence, String fullDescription) Begin output of documentation for a given class.void
startMember
(String memberName, String memberType, String memberId, String description) Begin output of documentation for a given class member (field or method).void
Called at the start of operation.
-
Constructor Details
-
XmlDocletOutput
Constructor.- Parameters:
out
- destination streamheadOnly
- if true, only a short summary of each class will be writtenclazzToId
- maps fully-qualified classname to the (base) XML ID that will be used for that class in the XML output
-
-
Method Details
-
startOutput
Description copied from interface:DocletOutput
Called at the start of operation.- Specified by:
startOutput
in interfaceDocletOutput
- Throws:
IOException
-
endOutput
Description copied from interface:DocletOutput
Called at the end of operation.- Specified by:
endOutput
in interfaceDocletOutput
- Throws:
IOException
-
startClass
public void startClass(String className, String firstSentence, String fullDescription) throws IOException Description copied from interface:DocletOutput
Begin output of documentation for a given class.- Specified by:
startClass
in interfaceDocletOutput
- Parameters:
className
- fully qualified class namefirstSentence
- first sentence of class description, in HTMLfullDescription
- full text of class description, in HTML- Throws:
IOException
-
endClass
Description copied from interface:DocletOutput
End output of documentation for the most recently started class.- Specified by:
endClass
in interfaceDocletOutput
- Throws:
IOException
-
startMember
public void startMember(String memberName, String memberType, String memberId, String description) throws IOException Description copied from interface:DocletOutput
Begin output of documentation for a given class member (field or method).- Specified by:
startMember
in interfaceDocletOutput
- Parameters:
memberName
- user-readable name of the membermemberType
- some user-readable (maybe avoiding technical terms) description of what kind of member it ismemberId
- string uniquely identifying this member within its parent classdescription
- full text of member description, in HTML- Throws:
IOException
-
endMember
Description copied from interface:DocletOutput
End output of the most recently started member.- Specified by:
endMember
in interfaceDocletOutput
- Throws:
IOException
-
outMemberItem
This information is discarded; the XML output is too terse to include it.- Specified by:
outMemberItem
in interfaceDocletOutput
- Parameters:
name
- item nameval
- item value, may be HTML- Throws:
IOException
-
outParameters
Description copied from interface:DocletOutput
Writes a description of the parameters of a method.- Specified by:
outParameters
in interfaceDocletOutput
- Parameters:
params
- parameter list- Throws:
IOException
-
outReturn
Description copied from interface:DocletOutput
Writes information about the return value of a method.- Specified by:
outReturn
in interfaceDocletOutput
- Parameters:
type
- return type specification for presentation to the usercomment
- description of returned value, may be HTML- Throws:
IOException
-
outExamples
Description copied from interface:DocletOutput
Writes one or more example entries.- Specified by:
outExamples
in interfaceDocletOutput
- Parameters:
heading
- heading for examples sectionexamples
- list of example lines, may be HTML- Throws:
IOException
-
outSees
Description copied from interface:DocletOutput
Writes one or more See Also entries.- Specified by:
outSees
in interfaceDocletOutput
- Parameters:
heading
- heading for See Also sectionsees
- list of entries, may be HTML- Throws:
IOException
-