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

Klasse AllPackagesIndexWriter

java.lang.Object

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

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

public class AllPackagesIndexWriter
extends HtmlDocletWriter

Generate the file with list of all the packages in this run.

Feldübersicht

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
AllPackagesIndexWriter(HtmlConfiguration configuration, DocPath filename)	Construct AllPackagesIndexWriter object.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addPackages(Content target)	Add all the packages to the content.
protected void	buildAllPackagesFile()	Print all the packages in the file.
static void	generate(HtmlConfiguration configuration)	Create AllPackagesIndexWriter object.

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

Konstruktordetails

AllPackagesIndexWriter

public AllPackagesIndexWriter(HtmlConfiguration configuration,
 DocPath filename)

Construct AllPackagesIndexWriter object.

Parameter:

configuration - The current configuration

filename - Path to the file which is getting generated.

Methodendetails

generate

public static void generate(HtmlConfiguration configuration)
                     throws DocFileIOException

Create AllPackagesIndexWriter object.

Parameter:

configuration - The current configuration

Löst aus:

DocFileIOException

buildAllPackagesFile

protected void buildAllPackagesFile()
                             throws DocFileIOException

Print all the packages in the file.

Löst aus:

DocFileIOException

addPackages

protected void addPackages(Content target)

Add all the packages to the content.

Parameter:

target - the content to which the links will be added