OpenJDK 27 · jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter

Constructor Summary

Access	Constructor and Description
public	AbstractOverviewIndexWriter(HtmlConfiguration The current configuration configuration, DocPath Name of the module index file to be generated. filename) Constructs the AbstractOverviewIndexWriter.

Method Summary

Modifier and Type	Method and Description
protected void	addConfigurationTitle(Content the content to which the title will be added target) Adds the doctitle to the documentation, if it is specified on the command line.
protected abstract void	addIndex(Content the content to which the packages/modules list will be added target) Adds the index to the documentation.
protected void	addOverviewComment(Content the content to which the overview comment will be added content) Adds the overview comment as provided in the file specified by the "-overview" option on the command line.
protected void	addOverviewHeader(Content the content to which the overview header will be added target) Adds the overview summary comment for this documentation.
protected void	addOverviewTags(Content the content to which the tags will be added content) Adds the block tags provided in the file specified by the "-overview" option.
public void	buildPage() Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. The top-level method to generate and write the page represented by this writer.
protected abstract String	Returns: the page description, for the `<meta>` element getDescription() Returns the page description, for the `<meta>` element.
protected abstract String	Returns: the title for the page getTitleKey() Returns the title for the page.
public boolean	isIndexable() Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable. Returns true if the page written by this writer should be indexed, false otherwise.

Inherited from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter:: addInlineComment addInlineComment addInlineDeprecatedComment addPreQualifiedClassLink addPreQualifiedClassLink addPreQualifiedStrongClassLink addPreviewComment addPreviewInfo addPreviewSummary addRestrictedInfo addRestrictedSummary addSrcLink addSummaryComment addSummaryComment addSummaryDeprecatedComment addTagsInfo commentTagsToContent commentTagsToContent commentTagsToContent createTableOfContents getAnnotationInfo getAnnotationInfo getAnnotations getBlockTagOutput getBlockTagOutput getBody getBodyStyle getCrossClassLink getCrossModuleLink getCrossPackageLink getCurrentTypeElement getDeprecatedPhrase getDescription getDocLink getDocLink getDocLink getDocLink getDocLink getEnclosingPackageName getFileTitle getFooter getGenerator getHeader getHeader getLink getLocalizedPackageName getLocalStylesheets getModuleLink getModuleLink getNavBar getNavLinkToOverviewTree getPackageLabel getPackageLink getPackageLink getPackageTableHeader getPreQualifiedClassLink getQualifiedClassLink getTagletWriterInstance getTagletWriterInstance getTypeParameterLinks getWindowTitle hasSerializationOverviewTags ignoreNonInlineTag invalidTagOutput pathString pathString printHtmlDocument printHtmlDocument printHtmlDocument replaceDocRootDir resolveExternalSpecURI writeGenerating

Constructor Detail

AbstractOverviewIndexWriter	back to summary
public AbstractOverviewIndexWriter(HtmlConfiguration configuration, DocPath filename) Constructs the AbstractOverviewIndexWriter. Parameters configuration:HtmlConfiguration The current configuration filename:DocPath Name of the module index file to be generated.

AbstractOverviewIndexWriter

back to summary

public AbstractOverviewIndexWriter(HtmlConfiguration configuration, DocPath filename)

Constructs the AbstractOverviewIndexWriter.

Parameters

configuration:HtmlConfiguration: The current configuration
filename:DocPath: Name of the module index file to be generated.

Method Detail

addConfigurationTitle	back to summary
protected void addConfigurationTitle(Content target) Adds the doctitle to the documentation, if it is specified on the command line. Parameters target:Content the content to which the title will be added

addConfigurationTitle

back to summary

protected void addConfigurationTitle(Content target)

Adds the doctitle to the documentation, if it is specified on the command line.

Parameters

target:Content: the content to which the title will be added

addIndex	back to summary
protected abstract void addIndex(Content target) Adds the index to the documentation. Parameters target:Content the content to which the packages/modules list will be added

addIndex

back to summary

protected abstract void addIndex(Content target)

Adds the index to the documentation.

Parameters

target:Content: the content to which the packages/modules list will be added

addOverviewComment	back to summary
protected void addOverviewComment(Content content) Adds the overview comment as provided in the file specified by the "-overview" option on the command line. Parameters content:Content the content to which the overview comment will be added

addOverviewComment

back to summary

protected void addOverviewComment(Content content)

Adds the overview comment as provided in the file specified by the "-overview" option on the command line.

Parameters

content:Content: the content to which the overview comment will be added

addOverviewHeader	back to summary
protected void addOverviewHeader(Content target) Adds the overview summary comment for this documentation. Add one line summary at the top of the page and generate a link to the description, which is added at the end of this page. Parameters target:Content the content to which the overview header will be added

addOverviewHeader

back to summary

protected void addOverviewHeader(Content target)

Adds the overview summary comment for this documentation. Add one line summary at the top of the page and generate a link to the description, which is added at the end of this page.

Parameters

target:Content: the content to which the overview header will be added

addOverviewTags	back to summary
protected void addOverviewTags(Content content) Adds the block tags provided in the file specified by the "-overview" option. Parameters content:Content the content to which the tags will be added

addOverviewTags

back to summary

protected void addOverviewTags(Content content)

Adds the block tags provided in the file specified by the "-overview" option.

Parameters

content:Content: the content to which the tags will be added

buildPage	back to summary
public void buildPage() throws DocFileIOException Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. The top-level method to generate and write the page represented by this writer. Annotations @Override

buildPage

back to summary

public void buildPage() throws DocFileIOException

Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

The top-level method to generate and write the page represented by this writer.

Annotations

@Override

getDescription back to summary

getDescription	back to summary
protected abstract String getDescription() Returns the page description, for the `<meta>` element. Returns:String the page description, for the `<meta>` element

protected abstract String getDescription()

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

Returns:String: the page description, for the <meta> element

getTitleKey	back to summary
protected abstract String getTitleKey() Returns the title for the page. Returns:String the title for the page

getTitleKey

back to summary

protected abstract String getTitleKey()

Returns the title for the page.

Returns:String: the title for the page

isIndexable	back to summary
public boolean isIndexable() Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable. Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable. Returns true if the page written by this writer should be indexed, false otherwise. Some pages merely aggregate filtered information available on other pages and, thus, have no indexing value. In fact, if indexed, they would clutter the index and mislead the reader. Annotations @Override

isIndexable

back to summary

public boolean isIndexable()

Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable.

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable.

Returns true if the page written by this writer should be indexed, false otherwise. Some pages merely aggregate filtered information available on other pages and, thus, have no indexing value. In fact, if indexed, they would clutter the index and mislead the reader.

Annotations

@Override

public abstract Class AbstractOverviewIndexWriter

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail