APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.formats.html

public Class ModuleIndexWriter

extends AbstractOverviewIndexWriter
Class Inheritance
Imports
java.util.Map, .Set, .SortedSet, javax.lang.model.element.ModuleElement, jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, jdk.javadoc.internal.doclets.toolkit.util.DocPaths, jdk.javadoc.internal.html.Content, .ContentBuilder, .Text
Generate the module index page "index.html".

Field Summary

Modifier and TypeField and Description
protected SortedSet<ModuleElement>
modules

Modules to be documented.

Constructor Summary

AccessConstructor and Description
public
ModuleIndexWriter(HtmlConfiguration
the configuration object
configuration)

Construct the ModuleIndexWriter.

Method Summary

Modifier and TypeMethod and Description
protected void
addIndex(Content
the content to which the modules list will be added
target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter.addIndex.

Adds the list of modules.

public String
getDescription()

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter.getDescription.

Returns the page description, for the <meta> element.

public String
getTitleKey()

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter.getTitleKey.

Returns the title for the page.

Inherited from jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter:
addConfigurationTitleaddOverviewCommentaddOverviewHeaderaddOverviewTagsbuildPageisIndexable

Field Detail

modulesback to summary
protected SortedSet<ModuleElement> modules

Modules to be documented.

Constructor Detail

ModuleIndexWriterback to summary
public ModuleIndexWriter(HtmlConfiguration configuration)

Construct the ModuleIndexWriter.

Parameters
configuration:HtmlConfiguration

the configuration object

Method Detail

addIndexback to summary
protected void addIndex(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter.addIndex.

Adds the list of modules.

Parameters
target:Content

the content to which the modules list will be added

Annotations
@Override
getDescriptionback to summary
public String getDescription()

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter.getDescription.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter.getDescription.

Returns the page description, for the <meta> element.

Annotations
@Override
getTitleKeyback to summary
public String getTitleKey()

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter.getTitleKey.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter.getTitleKey.

Returns the title for the page.

Annotations
@Override