Package org.jdrupes.mdoclet.internal.doclets.toolkit

Klasse AbstractDoclet

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.AbstractDoclet

Alle implementierten Schnittstellen:

Doclet

Bekannte direkte Unterklassen:

HtmlDoclet

public abstract class AbstractDoclet
extends Object
implements Doclet

An abstract implementation of a Doclet.

Verschachtelte Klassen - Übersicht

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen jdk.javadoc.doclet.Doclet

Doclet.Option

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected Messages	messages
protected Utils	utils

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
AbstractDoclet()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected abstract void	generateClassFiles(SortedSet<TypeElement> arr, ClassTree classTree)	Generate the class documentation.
protected void	generateClassFiles(ClassTree classTree)	Iterate through all classes and construct documentation for them.
protected abstract void	generateModuleFiles()	Generate the module documentation.
protected void	generateOtherFiles(ClassTree classTree)	Generate additional documentation that is added to the API documentation.
protected abstract void	generatePackageFiles(ClassTree classTree)	Generate the package documentation.
abstract BaseConfiguration	getConfiguration()	Create the configuration instance and returns it.
protected Function<String,String>	getResourceKeyMapper(DocletEnvironment docEnv)
SourceVersion	getSupportedSourceVersion()	Returns the SourceVersion indicating the features supported by this doclet.
boolean	run(DocletEnvironment docEnv)	The method that starts the execution of the doclet.

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden jdk.javadoc.doclet.Doclet

getName, getSupportedOptions, init

Felddetails

messages

protected Messages messages

utils

protected Utils utils

Konstruktordetails

AbstractDoclet

public AbstractDoclet()

Methodendetails

run

public boolean run(DocletEnvironment docEnv)

The method that starts the execution of the doclet.

Angegeben von:

run in Schnittstelle Doclet

Parameter:

docEnv - the DocletEnvironment.

Gibt zurück:

true if the doclet executed without error. False otherwise.

getResourceKeyMapper

protected Function<String,String> getResourceKeyMapper(DocletEnvironment docEnv)

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Returns the SourceVersion indicating the features supported by this doclet.

Angegeben von:

getSupportedSourceVersion in Schnittstelle Doclet

Gibt zurück:

SourceVersion

getConfiguration

public abstract BaseConfiguration getConfiguration()

Create the configuration instance and returns it.

Gibt zurück:

the configuration of the doclet.

generateOtherFiles

protected void generateOtherFiles(ClassTree classTree)
                           throws DocletException

Generate additional documentation that is added to the API documentation.

Parameter:

classTree - the data structure representing the class tree

Löst aus:

DocletException - if there is a problem while generating the documentation

generateModuleFiles

protected abstract void generateModuleFiles()
                                     throws DocletException

Generate the module documentation.

Löst aus:

DocletException - if there is a problem while generating the documentation

generatePackageFiles

protected abstract void generatePackageFiles(ClassTree classTree)
                                      throws DocletException

Generate the package documentation.

Parameter:

classTree - the data structure representing the class tree

Löst aus:

DocletException - if there is a problem while generating the documentation

generateClassFiles

protected abstract void generateClassFiles(SortedSet<TypeElement> arr,
 ClassTree classTree)
                                    throws DocletException

Generate the class documentation.

Parameter:

arr - the set of types to be documented

classTree - the data structure representing the class tree

Löst aus:

DocletException - if there is a problem while generating the documentation

generateClassFiles

protected void generateClassFiles(ClassTree classTree)
                           throws DocletException

Iterate through all classes and construct documentation for them.

Parameter:

classTree - the data structure representing the class tree

Löst aus:

DocletException - if there is a problem while generating the documentation