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

Klasse PackageIndexWriter

java.lang.Object

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

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

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

public class PackageIndexWriter
extends AbstractOverviewIndexWriter

Generate the package index page “index.html”.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected SortedSet<PackageElement>	packages	A Set of Packages to be documented.

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

comparators, configuration, contents, docPaths, filename, htmlIds, links, mainBodyScript, messages, options, path, pathToRoot, resources, utils, winTitle

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
PackageIndexWriter(HtmlConfiguration configuration, DocPath filename)	Construct the PackageIndexWriter.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addIndex(Content target)	Adds the packages list to the documentation tree.
static void	generate(HtmlConfiguration configuration)	Generate the package index page.

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.formats.html.AbstractOverviewIndexWriter

addConfigurationTitle, addOverviewComment, addOverviewHeader, addOverviewTags, buildOverviewIndexFile

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

addInlineComment, addInlineComment, addInlineDeprecatedComment, addPreQualifiedClassLink, addPreQualifiedClassLink, addPreQualifiedStrongClassLink, addPreviewComment, addPreviewInfo, addPreviewSummary, addSrcLink, addSummaryComment, addSummaryComment, addSummaryDeprecatedComment, addTagsInfo, commentTagsToContent, commentTagsToContent, commentTagsToContent, getAnnotations, getBlockTagOutput, getBlockTagOutput, getBody, getBodyStyle, getCrossClassLink, getCrossModuleLink, getCrossPackageLink, getCurrentPageElement, getDeprecatedPhrase, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getEnclosingPackageName, getFooter, getHeader, getHeader, getLink, getLocalizedPackageName, getModuleLink, getModuleLink, getNavBar, getNavLinkToOverviewTree, getPackageLabel, getPackageLink, getPackageLink, getPackageTableHeader, getPreQualifiedClassLink, getQualifiedClassLink, getTagletWriterInstance, getTagletWriterInstance, getTypeParameterLinks, getWindowTitle, hasSerializationOverviewTags, invalidTagOutput, pathString, pathString, printHtmlDocument, printHtmlDocument, printHtmlDocument, replaceDocRootDir, resolveExternalSpecURI

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

packages

protected SortedSet<PackageElement> packages

A Set of Packages to be documented.

Konstruktordetails

PackageIndexWriter

public PackageIndexWriter(HtmlConfiguration configuration,
 DocPath filename)

Construct the PackageIndexWriter.

Also constructs the grouping information as provided on the command line by “-group” option. Stores the order of groups specified by the user.

Parameter:

configuration - the configuration for this doclet

filename - the path of the page to be generated

Siehe auch:

• Group

Methodendetails

generate

public static void generate(HtmlConfiguration configuration)
                     throws DocFileIOException

Generate the package index page.

Parameter:

configuration - the current configuration of the doclet.

Löst aus:

DocFileIOException - if there is a problem generating the package index page

addIndex

protected void addIndex(Content target)

Adds the packages list to the documentation tree.

Angegeben von:

addIndex in Klasse AbstractOverviewIndexWriter

Parameter:

target - the content to which the packages list will be added