Package uk.ac.starlink.ttools.build
Class SunDoclet
java.lang.Object
uk.ac.starlink.ttools.build.SunDoclet
Doclet for documenting user-visible JEL classes,
based on the com.sun.javadoc API.
At Java 8 and below, the com.sun.javadoc
API is the
standard/only way to parse javadocs.
At Java 9 it is deprecated in favour of the
jdk.javadoc.doclet
API, and at Java 17 it is withdrawn
altogether.
If the target build platform is ever moved to Java 9 or later,
this class should be retired in favour of JdkDoclet
.
- Since:
- 26 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. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic LanguageVersion
This magic static method appears to be required on Doclet classes to make theisVarArgs()
method oncom.sun.javadoc.ExecutableMemberDoc
report variable argument status.boolean
process()
Works through the root document invoking the various protected methods to produce output.
-
Constructor Details
-
SunDoclet
Constructor.- Parameters:
root
- document tree rootoutput
- output destination
-
-
Method Details
-
process
Works through the root document invoking the various protected methods to produce output.- Throws:
IOException
-
languageVersion
public static LanguageVersion languageVersion()This magic static method appears to be required on Doclet classes to make theisVarArgs()
method oncom.sun.javadoc.ExecutableMemberDoc
report variable argument status. I don't know whether or where that's documented, but I found out from StackOverflow.- Returns:
- LanguageVersion.JAVA_1_5
-