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

Klasse ModuleIndexWriter

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.ModuleIndexWriter

public class ModuleIndexWriter
extends AbstractOverviewIndexWriter

Generate the module index page “index.html”.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected SortedSet<ModuleElement>	modules	Modules 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
ModuleIndexWriter(HtmlConfiguration configuration, DocPath filename)	Construct the ModuleIndexWriter.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addIndex(Content target)	Adds the list of modules.
static void	generate(HtmlConfiguration configuration)	Generate the module 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

modules

protected SortedSet<ModuleElement> modules

Modules to be documented.

Konstruktordetails

ModuleIndexWriter

public ModuleIndexWriter(HtmlConfiguration configuration,
 DocPath filename)

Construct the ModuleIndexWriter.

Parameter:

configuration - the configuration object

filename - the name of the generated file

Methodendetails

generate

public static void generate(HtmlConfiguration configuration)
                     throws DocFileIOException

Generate the module index page.

Parameter:

configuration - the current configuration of the doclet.

Löst aus:

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

addIndex

protected void addIndex(Content target)

Adds the list of modules.

Angegeben von:

addIndex in Klasse AbstractOverviewIndexWriter

Parameter:

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