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

Klasse SearchWriter

java.lang.Object

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

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

public class SearchWriter
extends HtmlDocletWriter

Generates the search landing page for the generated API documentation.

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
SearchWriter(HtmlConfiguration configuration, DocPath filename)	Constructor to construct SearchWriter object.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addSearchFileContents(Content contentTree)	Adds the search file contents to the content tree.
static void	generate(HtmlConfiguration configuration)	Constructs the SearchWriter object and then use it to generate the search file.
protected void	generateSearchFile()	Generates the search file contents.

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

SearchWriter

public SearchWriter(HtmlConfiguration configuration,
 DocPath filename)

Constructor to construct SearchWriter object.

Parameter:

configuration - the configuration

filename - file to be generated

Methodendetails

generate

public static void generate(HtmlConfiguration configuration)
                     throws DocFileIOException

Constructs the SearchWriter object and then use it to generate the search file.

The name of the generated file is “search.html”. The search file will get generated if and only if “-noindex” is not used on the command line.

Parameter:

configuration - the configuration

Löst aus:

DocFileIOException - if there is a problem while generating the documentation

generateSearchFile

protected void generateSearchFile()
                           throws DocFileIOException

Generates the search file contents.

Löst aus:

DocFileIOException - if there is a problem while generating the documentation

addSearchFileContents

protected void addSearchFileContents(Content contentTree)

Adds the search file contents to the content tree.