uk.ac.starlink.ttools.build

Class JdkDoclet

java.lang.Object

uk.ac.starlink.ttools.build.JdkDoclet

Direct Known Subclasses:

JdkDoclet.Html, JdkDoclet.Xml

public abstract class JdkDoclet
extends Object

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 Classes

Modifier and Type	Class and Description
static class	JdkDoclet.Html Class for use with javadoc tool that writes MethodBrowser-friendly HTML output.
static class	JdkDoclet.Xml Class for use with javadoc tool that writes SUN-friendly XML output.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JdkDoclet(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract DocletOutput	createOutput() Must provide a format-specific output backend.
String	getName()
javax.lang.model.SourceVersion	getSupportedSourceVersion()
void	init(Locale locale, Reporter reporter)
boolean	run(DocletEnvironment env)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JdkDoclet

protected JdkDoclet(String name)

Constructor.

Parameters:

name - doclet name

Method Detail

getName

public String getName()

getSupportedSourceVersion

public javax.lang.model.SourceVersion getSupportedSourceVersion()

init

public void init(Locale locale,
                 Reporter reporter)

createOutput

protected abstract DocletOutput createOutput()
                                      throws IOException

Must provide a format-specific output backend. Called during the doclet run(DocletEnvironment) method, after option configuration.

Returns:

output instance

Throws:

IOException

run

public boolean run(DocletEnvironment env)