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

Klasse AbstractOverviewIndexWriter

java.lang.Object

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

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

Bekannte direkte Unterklassen:

ModuleIndexWriter, PackageIndexWriter

public abstract class AbstractOverviewIndexWriter
extends HtmlDocletWriter

Abstract class to generate the overview files.

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
AbstractOverviewIndexWriter(HtmlConfiguration configuration, DocPath filename)	Constructs the AbstractOverviewIndexWriter.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addConfigurationTitle(Content target)	Adds the doctitle to the documentation, if it is specified on the command line.
protected abstract void	addIndex(Content target)	Adds the index to the documentation.
protected void	addOverviewComment(Content content)	Adds the overview comment as provided in the file specified by the “-overview” option on the command line.
protected void	addOverviewHeader(Content target)	Adds the overview summary comment for this documentation.
protected void	addOverviewTags(Content content)	Adds the block tags provided in the file specified by the “-overview” option.
protected void	buildOverviewIndexFile(String title, String description)	Generate and prints the contents in the index file.

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

AbstractOverviewIndexWriter

public AbstractOverviewIndexWriter(HtmlConfiguration configuration,
 DocPath filename)

Constructs the AbstractOverviewIndexWriter.

Parameter:

configuration - The current configuration

filename - Name of the module index file to be generated.

Methodendetails

addOverviewHeader

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.

Parameter:

target - the content to which the overview header will be added

addOverviewComment

protected void addOverviewComment(Content content)

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

Parameter:

content - the content to which the overview comment will be added

addOverviewTags

protected void addOverviewTags(Content content)

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

Parameter:

content - the content to which the tags will be added

buildOverviewIndexFile

protected void buildOverviewIndexFile(String title,
 String description)
                               throws DocFileIOException

Generate and prints the contents in the index file.

Parameter:

title - the title of the window

description - the content for the description META tag

Löst aus:

DocFileIOException - if there is a problem building the package index file

addIndex

protected abstract void addIndex(Content target)

Adds the index to the documentation.

Parameter:

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

addConfigurationTitle

protected void addConfigurationTitle(Content target)

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

Parameter:

target - the content to which the title will be added