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

Klasse PackageSummaryBuilder

java.lang.Object

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

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

public class PackageSummaryBuilder
extends AbstractBuilder

Builds the summary for a given package.

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 package summary.
protected void	buildAllClassesAndInterfacesSummary(Content summariesList)	Builds the summary for all classes and interfaces in this package.
protected void	buildContent()	Build the content for the package.
protected void	buildPackageDescription(Content packageContent)	Build the description of the summary.
protected void	buildPackageDoc()	Build the package documentation.
protected void	buildPackageTags(Content packageContent)	Build the tags of the summary.
protected void	buildRelatedPackagesSummary(Content summariesList)	Builds a list of “nearby” packages (subpackages, superpackages, and sibling packages).
protected void	buildSummary(Content packageContent)	Builds the list of summaries for the different kinds of types in this package.
static PackageSummaryBuilder	getInstance(AbstractBuilder.Context context, PackageElement pkg, PackageSummaryWriter packageWriter)	Construct a new PackageSummaryBuilder.

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

getInstance

public static PackageSummaryBuilder getInstance(AbstractBuilder.Context context,
 PackageElement pkg,
 PackageSummaryWriter packageWriter)

Construct a new PackageSummaryBuilder.

Parameter:

context - the build context.

pkg - the package being documented.

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

Gibt zurück:

an instance of a PackageSummaryBuilder.

build

public void build()
           throws DocletException

Build the package summary.

Angegeben von:

build in Klasse AbstractBuilder

Löst aus:

DocletException - if there is a problem while building the documentation

buildPackageDoc

protected void buildPackageDoc()
                        throws DocletException

Build the package 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 package.

Löst aus:

DocletException - if there is a problem while building the documentation

buildSummary

protected void buildSummary(Content packageContent)
                     throws DocletException

Builds the list of summaries for the different kinds of types in this package.

Parameter:

packageContent - the package content to which the summaries will be added

Löst aus:

DocletException - if there is a problem while building the documentation

buildRelatedPackagesSummary

protected void buildRelatedPackagesSummary(Content summariesList)

Builds a list of “nearby” packages (subpackages, superpackages, and sibling packages).

Parameter:

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

buildAllClassesAndInterfacesSummary

protected void buildAllClassesAndInterfacesSummary(Content summariesList)

Builds the summary for all classes and interfaces in this package.

Parameter:

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

buildPackageDescription

protected void buildPackageDescription(Content packageContent)

Build the description of the summary.

Parameter:

packageContent - the content to which the package description will be added

buildPackageTags

protected void buildPackageTags(Content packageContent)

Build the tags of the summary.

Parameter:

packageContent - the content to which the package tags will be added