Module io.spring.javaformat.doclet

Package io.spring.javaformat.doclet

Class OfflineLinksDoclet

java.lang.Object

jdk.javadoc.doclet.StandardDoclet

io.spring.javaformat.doclet.OfflineLinksDoclet

All Implemented Interfaces:

Doclet

public class OfflineLinksDoclet
extends StandardDoclet

StandardDoclet designed to improve the process of working with offline links. Allows -linkoffline locations to be templated against source directories, and verifies that links actually point to known packages. to check that packages from link tags are found. Currenlt only offline links are checked.

Author:

Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Doclet

Doclet.Option

Constructor Summary

Constructors

Constructor	Description
OfflineLinksDoclet()

Method Summary

Modifier and Type	Method	Description
Set<? extends Doclet.Option>	getSupportedOptions()
boolean	run(DocletEnvironment environment)

Methods inherited from class jdk.javadoc.doclet.StandardDoclet

getLocale, getName, getReporter, getSupportedSourceVersion, init

Methods inherited from class java.lang.Object

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

Constructor Details

OfflineLinksDoclet

public OfflineLinksDoclet()

Method Details

getSupportedOptions

public Set<? extends Doclet.Option> getSupportedOptions()

Specified by:

getSupportedOptions in interface Doclet

Overrides:

getSupportedOptions in class StandardDoclet

run

public boolean run(DocletEnvironment environment)

Specified by:

run in interface Doclet

Overrides:

run in class StandardDoclet