Package capital.scalable.restdocs.jsondoclet

Class ExtractDocumentationAsJsonDoclet

java.lang.Object

jdk.javadoc.doclet.StandardDoclet

capital.scalable.restdocs.jsondoclet.ExtractDocumentationAsJsonDoclet

All Implemented Interfaces:

Doclet

public class ExtractDocumentationAsJsonDoclet
extends StandardDoclet

Javadoc to JSON doclet.

Implementation note: this doclet extends the default doclet, mainly to be able to ignore the default parameters. See the getSupportedOptions() method.

Nested Class Summary

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

Doclet.Option

Constructor Summary

Constructors

Constructor	Description
ExtractDocumentationAsJsonDoclet()

Method Summary

Modifier and Type	Method	Description
Set<Doclet.Option>	getSupportedOptions()	Running a doclet with unknown options results in an error.
boolean	run(DocletEnvironment docEnv)

Methods inherited from class jdk.javadoc.doclet.StandardDoclet

getName, getSupportedSourceVersion, init

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtractDocumentationAsJsonDoclet

public ExtractDocumentationAsJsonDoclet()

Method Detail

run

public boolean run(DocletEnvironment docEnv)

Specified by:

run in interface Doclet

Overrides:

run in class StandardDoclet

getSupportedOptions

public Set<Doclet.Option> getSupportedOptions()

Running a doclet with unknown options results in an error. Therefore, we include all default options in the list of possible options, even though we have no way of accessing those. If we want one of the default options, we need to extract them and override them.

Specified by:

getSupportedOptions in interface Doclet

Overrides:

getSupportedOptions in class StandardDoclet

Returns:

The options we want and those we want to ignore.