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

Klasse ExternalSpecsWriter

java.lang.Object

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

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

public class ExternalSpecsWriter
extends HtmlDocletWriter

Generates the file with the summary of all the references to external specifications.

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

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addExternalSpecs(Content content)	Adds all the references to external specifications to the content tree.
protected void	buildExternalSpecsPage()	Prints all the “external specs” to the file.
protected void	checkUniqueItems()
static void	generate(HtmlConfiguration configuration)

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

ExternalSpecsWriter

public ExternalSpecsWriter(HtmlConfiguration configuration,
 DocPath filename)

Constructs ExternalSpecsWriter object.

Parameter:

configuration - The current configuration

filename - Path to the file which is getting generated.

Methodendetails

generate

public static void generate(HtmlConfiguration configuration)
                     throws DocFileIOException

Löst aus:

DocFileIOException

buildExternalSpecsPage

protected void buildExternalSpecsPage()
                               throws DocFileIOException

Prints all the “external specs” to the file.

Löst aus:

DocFileIOException

checkUniqueItems

protected void checkUniqueItems()

addExternalSpecs

protected void addExternalSpecs(Content content)

Adds all the references to external specifications to the content tree.

Parameter:

content - HtmlTree content to which the links will be added