Package org.jdrupes.mdoclet.internal.doclets.formats.html

Klasse HtmlDoclet

java.lang.Object

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

org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDoclet

Alle implementierten Schnittstellen:

Doclet

public class HtmlDoclet
extends AbstractDoclet

The class with “start” method, calls individual Writers.

Verschachtelte Klassen - Übersicht

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

Doclet.Option

Feldübersicht

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.AbstractDoclet

utils

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
HtmlDoclet(Doclet initiatingDoclet)	Creates a doclet to generate HTML documentation, specifying the “initiating doclet” to be used when initializing any taglets for this doclet.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	generateClassFiles(SortedSet<TypeElement> typeElems, ClassTree classTree)	Generate the class documentation.
void	generateClassFiles(ClassTree classTree)	Iterate through all classes and construct documentation for them.
protected void	generateModuleFiles()	Generate the module documentation.
protected void	generateOtherFiles(ClassTree classTree)	Start the generation of files.
protected void	generatePackageFiles(ClassTree classTree)	Generate the package documentation.
HtmlConfiguration	getConfiguration()	Create the configuration instance.
String	getName()
protected Function<String,String>	getResourceKeyMapper(DocletEnvironment docEnv)
Set<? extends Doclet.Option>	getSupportedOptions()
void	init(Locale locale, Reporter reporter)

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.AbstractDoclet

getSupportedSourceVersion, run

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

HtmlDoclet

public HtmlDoclet(Doclet initiatingDoclet)

Creates a doclet to generate HTML documentation, specifying the “initiating doclet” to be used when initializing any taglets for this doclet.

An initiating doclet is one that delegates to this doclet.

Parameter:

initiatingDoclet - the initiating doclet

Methodendetails

getName

public String getName()

init

public void init(Locale locale,
 Reporter reporter)

getConfiguration

public HtmlConfiguration getConfiguration()

Create the configuration instance.

Override this method to use a different configuration.

Angegeben von:

getConfiguration in Klasse AbstractDoclet

Gibt zurück:

the configuration

getResourceKeyMapper

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

Setzt außer Kraft:

getResourceKeyMapper in Klasse AbstractDoclet

generateClassFiles

public void generateClassFiles(ClassTree classTree)
                        throws DocletException

Beschreibung aus Klasse kopiert: AbstractDoclet

Iterate through all classes and construct documentation for them.

Setzt außer Kraft:

generateClassFiles in Klasse AbstractDoclet

Parameter:

classTree - the data structure representing the class tree

Löst aus:

DocletException - if there is a problem while generating the documentation

generateOtherFiles

protected void generateOtherFiles(ClassTree classTree)
                           throws DocletException

Start the generation of files.

Call generate methods in the individual writers, which will in turn generate the documentation files. Call the TreeWriter generation first to ensure the Class Hierarchy is built first and then can be used in the later generation.

For new format.

Setzt außer Kraft:

generateOtherFiles in Klasse AbstractDoclet

Parameter:

classTree - the data structure representing the class tree

Löst aus:

DocletException - if there is a problem while writing the other files

generateClassFiles

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

Beschreibung aus Klasse kopiert: AbstractDoclet

Generate the class documentation.

Angegeben von:

generateClassFiles in Klasse AbstractDoclet

Parameter:

typeElems - 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

generateModuleFiles

protected void generateModuleFiles()
                            throws DocletException

Beschreibung aus Klasse kopiert: AbstractDoclet

Generate the module documentation.

Angegeben von:

generateModuleFiles in Klasse AbstractDoclet

Löst aus:

DocletException - if there is a problem while generating the documentation

generatePackageFiles

protected void generatePackageFiles(ClassTree classTree)
                             throws DocletException

Beschreibung aus Klasse kopiert: AbstractDoclet

Generate the package documentation.

Angegeben von:

generatePackageFiles in Klasse AbstractDoclet

Parameter:

classTree - the data structure representing the class tree

Löst aus:

DocletException - if there is a problem while generating the documentation

getSupportedOptions

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