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

Klasse HtmlOptions

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.BaseOptions

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

public class HtmlOptions
extends BaseOptions

Storage for all options supported by the standard doclet, including the format-independent options handled by BaseOptions.

Some of the methods used to access the values of options have names that begin with a verb, such as createOverview or splitIndex. Unless otherwise stated, these methods should all be taken as just accessing the value of the associated option.

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen org.jdrupes.mdoclet.internal.doclets.toolkit.BaseOptions

BaseOptions.Hidden, BaseOptions.ModularityMismatchPolicy, BaseOptions.Option, BaseOptions.XOption

Feldübersicht

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.BaseOptions

DEFAULT_TAB_STOP_LENGTH

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
boolean	classUse()	Argument for command-line option -use.
boolean	createIndex()	Argument for command-line option -noindex.
boolean	createOverview()	Argument for command-line option -overview.
boolean	createTree()	Argument for command-line option -notree.
Set<? extends BaseOptions.Option>	getSupportedOptions()
String	helpFile()	Argument for command-line option -helpfile.
String	legalNotices()	Argument for command-line option –legal-notices.
boolean	noDeprecatedList()	Argument for command-line option -nodeprecated.
boolean	noExternalSpecsPage()	Argument for command-line option –no-external-specs-page.
boolean	noHelp()	Argument for command-line option -nohelp.
boolean	noNavbar()	Argument for command-line option -nonavbar.
void	setCreateOverview(boolean createOverview)
boolean	splitIndex()	Argument for command-line option -splitindex.
protected boolean	validateOptions()

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.BaseOptions

addTrailingFileSep, copyDocfileSubdirs, date, docEncoding, encoding, generalValidOptions, javafx, keywords, linkModularityMismatch, linkSource, noComment, noDeprecated, noPlatformLinks, noSince, noTimestamp, serialWarn, setDocEncoding, setJavaFX, showAuthor, showTaglets, showVersion, since, sinceLabel, snippetPath, sourceTabSize, specBaseURI, summarizeOverriddenMethods, tagletPath

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methodendetails

getSupportedOptions

public Set<? extends BaseOptions.Option> getSupportedOptions()

Setzt außer Kraft:

getSupportedOptions in Klasse BaseOptions

validateOptions

protected boolean validateOptions()

classUse

public boolean classUse()

Argument for command-line option -use.

True if command-line option “-use” is used. Default value is false.

createIndex

public boolean createIndex()

Argument for command-line option -noindex.

False if command-line option “-noindex” is used. Default value is true.

createOverview

public boolean createOverview()

Argument for command-line option -overview.

This is true if option “-overview” is used or option “-overview” is not used and number of packages is more than one.

setCreateOverview

public void setCreateOverview(boolean createOverview)

createTree

public boolean createTree()

Argument for command-line option -notree.

False if command-line option “-notree” is used. Default value is true.

helpFile

public String helpFile()

Argument for command-line option -helpfile.

legalNotices

public String legalNotices()

Argument for command-line option –legal-notices.

noDeprecatedList

public boolean noDeprecatedList()

Argument for command-line option -nodeprecated.

True if command-line option “-nodeprecated” is used. Default value is false.

noExternalSpecsPage

public boolean noExternalSpecsPage()

Argument for command-line option –no-external-specs-page.

True if command-line option “–no-external-specs-page” is used. Default value is false.

noHelp

public boolean noHelp()

Argument for command-line option -nohelp.

True if command-line option “-nohelp” is used. Default value is false.

noNavbar

public boolean noNavbar()

Argument for command-line option -nonavbar.

True if command-line option “-nonavbar” is used. Default value is false.

splitIndex

public boolean splitIndex()

Argument for command-line option -splitindex.

True if command-line option “-splitindex” is used. Default value is false.