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

Klasse ModuleSummaryBuilder

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

org.jdrupes.mdoclet.internal.doclets.toolkit.builders.ModuleSummaryBuilder

public class ModuleSummaryBuilder
extends AbstractBuilder

Builds the summary for a given module.

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

AbstractBuilder.Context

Feldübersicht

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

builderFactory, configuration, containingPackagesSeen, messages, options, resources, utils

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	build()	Build the module summary.
protected void	buildContent()	Build the content for the module doc.
protected void	buildModuleDescription(Content moduleContent)	Builds the description for this module.
protected void	buildModuleDoc()	Build the module documentation.
protected void	buildModulesSummary(Content summariesList)	Builds the summary of the module dependencies of this module.
protected void	buildPackagesSummary(Content summariesList)	Builds the summary of the packages exported or opened by this module.
protected void	buildServicesSummary(Content summariesList)	Builds the summary of the services used or provided by this module.
protected void	buildSummary(Content target)	Builds the list of summary sections for this module.
static ModuleSummaryBuilder	getInstance(AbstractBuilder.Context context, ModuleElement mdle, ModuleSummaryWriter moduleWriter)	Construct a new ModuleSummaryBuilder.

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

getInstance

public static ModuleSummaryBuilder getInstance(AbstractBuilder.Context context,
 ModuleElement mdle,
 ModuleSummaryWriter moduleWriter)

Construct a new ModuleSummaryBuilder.

Parameter:

context - the build context.

mdle - the module being documented.

moduleWriter - the doclet specific writer that will output the result.

Gibt zurück:

an instance of a ModuleSummaryBuilder.

build

public void build()
           throws DocletException

Build the module summary.

Angegeben von:

build in Klasse AbstractBuilder

Löst aus:

DocletException - if there is a problem while building the documentation

buildModuleDoc

protected void buildModuleDoc()
                       throws DocletException

Build the module documentation.

Löst aus:

DocletException - if there is a problem while building the documentation

buildContent

protected void buildContent()
                     throws DocletException

Build the content for the module doc.

Löst aus:

DocletException - if there is a problem while building the documentation

buildSummary

protected void buildSummary(Content target)
                     throws DocletException

Builds the list of summary sections for this module.

Parameter:

target - the module content to which the summaries will be added

Löst aus:

DocletException - if there is a problem while building the documentation

buildModulesSummary

protected void buildModulesSummary(Content summariesList)

Builds the summary of the module dependencies of this module.

Parameter:

summariesList - the list of summaries to which the summary will be added

buildPackagesSummary

protected void buildPackagesSummary(Content summariesList)

Builds the summary of the packages exported or opened by this module.

Parameter:

summariesList - the list of summaries to which the summary will be added

buildServicesSummary

protected void buildServicesSummary(Content summariesList)

Builds the summary of the services used or provided by this module.

Parameter:

summariesList - the list of summaries to which the summary will be added

buildModuleDescription

protected void buildModuleDescription(Content moduleContent)

Builds the description for this module.

Parameter:

moduleContent - the content to which the module description will be added