Package uk.ac.starlink.ttools.build
Class JdkDoclet
java.lang.Object
uk.ac.starlink.ttools.build.JdkDoclet
- All Implemented Interfaces:
jdk.javadoc.doclet.Doclet
- Direct Known Subclasses:
JdkDoclet.Html
,JdkDoclet.Xml
Doclet for documenting user-visible JEL library classes,
based on the jdk.javadoc.doclet API.
Two concrete implementations are provided as inner classes,
using different DocletOutput
backends.
The jdk.javadoc.doclet
API is available only at
Java 9 and later, so this class will not compile at earlier
JDK versions.
- Since:
- 27 Jan 2023
- Author:
- Mark Taylor
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Class for use withjavadoc
tool that writes MethodBrowser-friendly HTML output.static class
Class for use withjavadoc
tool that writes SUN-friendly XML output.Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Doclet
jdk.javadoc.doclet.Doclet.Option
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract DocletOutput
Must provide a format-specific output backend.getName()
void
boolean
run
(jdk.javadoc.doclet.DocletEnvironment env) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jdk.javadoc.doclet.Doclet
getSupportedOptions
-
Constructor Details
-
JdkDoclet
Constructor.- Parameters:
name
- doclet name
-
-
Method Details
-
getName
- Specified by:
getName
in interfacejdk.javadoc.doclet.Doclet
-
getSupportedSourceVersion
- Specified by:
getSupportedSourceVersion
in interfacejdk.javadoc.doclet.Doclet
-
init
- Specified by:
init
in interfacejdk.javadoc.doclet.Doclet
-
createOutput
Must provide a format-specific output backend. Called during the docletrun(jdk.javadoc.doclet.DocletEnvironment)
method, after option configuration.- Returns:
- output instance
- Throws:
IOException
-
run
public boolean run(jdk.javadoc.doclet.DocletEnvironment env) - Specified by:
run
in interfacejdk.javadoc.doclet.Doclet
-