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

Klasse HelpWriter

java.lang.Object

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

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

public class HelpWriter
extends HtmlDocletWriter

Generate the Help File for the generated API documentation.

The help file contents are helpful for browsing the generated 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
HelpWriter(HtmlConfiguration configuration, DocPath filename)	Constructor to construct HelpWriter object.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addHelpFileContents(Content content)	Adds the help file contents from the resource file to the content.
static void	generate(HtmlConfiguration configuration)	Construct the HelpWriter object and then use it to generate the help file.
protected void	generateHelpFile()	Generate the help file contents.
protected Navigation	getNavBar(Navigation.PageMode pageMode, Element element)	Returns a basic navigation bar for a kind of page and element.

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, 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

HelpWriter

public HelpWriter(HtmlConfiguration configuration,
 DocPath filename)

Constructor to construct HelpWriter object.

Parameter:

configuration - the configuration

filename - File to be generated.

Methodendetails

generate

public static void generate(HtmlConfiguration configuration)
                     throws DocFileIOException

Construct the HelpWriter object and then use it to generate the help file.

The name of the generated file is “help-doc.html”. The help file will get generated if and only if “-helpfile” and “-nohelp” is not used on the command line.

Parameter:

configuration - the configuration

Löst aus:

DocFileIOException - if there is a problem while generating the documentation

generateHelpFile

protected void generateHelpFile()
                         throws DocFileIOException

Generate the help file contents.

Löst aus:

DocFileIOException - if there is a problem while generating the documentation

addHelpFileContents

protected void addHelpFileContents(Content content)

Adds the help file contents from the resource file to the content.

While adding the help file contents it also keeps track of user options.

The general organization is:

• Heading, and TOC
• Navigation help
• Page-specific help

getNavBar

protected Navigation getNavBar(Navigation.PageMode pageMode,
 Element element)

Beschreibung aus Klasse kopiert: HtmlDocletWriter

Returns a basic navigation bar for a kind of page and element.

Setzt außer Kraft:

getNavBar in Klasse HtmlDocletWriter

Parameter:

pageMode - the page mode

element - the defining element for the navigation bar, or null if none

Gibt zurück:

the basic navigation bar