uk.ac.starlink.ttools.build

Class JdkDoclet.Html

java.lang.Object

uk.ac.starlink.ttools.build.JdkDoclet

uk.ac.starlink.ttools.build.JdkDoclet.Html

Enclosing class:

JdkDoclet

public static class JdkDoclet.Html
extends JdkDoclet

Class for use with javadoc tool that writes MethodBrowser-friendly HTML output.

Doclet flags:

• -d <base-dir>
• -headings

Nested Class Summary

Nested classes/interfaces inherited from class uk.ac.starlink.ttools.build.JdkDoclet

JdkDoclet.Html, JdkDoclet.Xml

Constructor Summary

Constructors

Constructor and Description
Html() No-arg constructor required by doclet API.

Method Summary

Modifier and Type	Method and Description
protected DocletOutput	createOutput() Must provide a format-specific output backend.
Set<Doclet.Option>	getSupportedOptions()

Methods inherited from class uk.ac.starlink.ttools.build.JdkDoclet

getName, getSupportedSourceVersion, init, run

Methods inherited from class java.lang.Object

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

Constructor Detail

Html

public Html()

No-arg constructor required by doclet API.

Method Detail

createOutput

protected DocletOutput createOutput()
                             throws IOException

Description copied from class: JdkDoclet

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

Specified by:

createOutput in class JdkDoclet

Returns:

output instance

Throws:

IOException

getSupportedOptions

public Set<Doclet.Option> getSupportedOptions()