OpenJDK 27 · jdk.javadoc.internal.doclets.formats.html.HtmlOptions

Field Summary

Modifier and Type	Field and Description
private List<String>	additionalScripts Argument for command-line option `--add-script`.
private List<String>	additionalStylesheets Argument for command-line option `--add-stylesheet`.
private String	bottom Argument for command-line option `-bottom`.
private String	charset Argument for command-line option `-charset`.
private boolean	classUse Argument for command-line option `-use`.
private HtmlConfiguration	config Hides jdk.javadoc.internal.doclets.toolkit.BaseOptions.config.
private boolean	createIndex Argument for command-line option `-noindex`.
private boolean	createOverview Argument for command-line option `-overview`.
private boolean	createTree Argument for command-line option `-notree`.
private final LinkedHashSet<List<String>>	customTagStrs Arguments for command-line option `-tag` and `-taglet`.
private List<String>	doclintOpts Arguments for command-line option `-Xdoclint` and friends.
private String	docrootParent Argument for command-line option `-Xdocrootparent`.
private String	docTitle Argument for command-line option `-doctitle`.
private String	header Argument for command-line option `-header`.
private String	helpFile Argument for command-line option `-helpfile`.
private String	legalNotices Argument for command-line option `--legal-notices`.
private boolean	noDeprecatedList Argument for command-line option `-nodeprecatedlist`.
private boolean	noHelp Argument for command-line option `-nohelp`.
private boolean	noNavbar Argument for command-line option `-nonavbar`.
private boolean	noOverview Argument for command-line option `-nooverview`.
private String	overviewPath Argument for command-line option `-overview`.
private String	packagesHeader Argument for command-line option `-packagesheader`.
private boolean	showTaglets Argument for command-line option `--show-taglets`.
private String	snippetPath Argument for command-line option `--snippet-path`.
private boolean	splitIndex Argument for command-line option `-splitindex`.
private String	stylesheetFile Argument for command-line option `-stylesheetfile`.
private boolean	syntaxHighlight Argument for command line option `--syntax-highlight`.
private String	tagletPath Argument for command-line option `-tagletpath`.
private String	top Argument for command-line option `-top`.
private String	windowTitle Argument for command-line option `-windowtitle`.

Inherited from jdk.javadoc.internal.doclets.toolkit.BaseOptions:: DEFAULT_TAB_STOP_LENGTH

Constructor Summary

Access	Constructor and Description
pack-priv	HtmlOptions(HtmlConfiguration config)

Method Summary

Modifier and Type	Method and Description
pack-priv List<String>	additionalScripts() Argument for command-line option `--add-script`.
pack-priv List<String>	additionalStylesheets() Argument for command-line option `--add-stylesheet`.
pack-priv String	bottom() Argument for command-line option `-bottom`.
pack-priv String	charset() Argument for command-line option `-charset`.
public boolean	classUse() Argument for command-line option `-use`.
public boolean	createIndex() Argument for command-line option `-noindex`.
public boolean	createOverview() Argument for command-line option `-overview`.
public boolean	createTree() Argument for command-line option `-notree`.
pack-priv LinkedHashSet<List<String>>	customTagStrs() Arguments for command-line option `-tag` and `-taglet`.
pack-priv List<String>	doclintOpts() Arguments for command-line option `-Xdoclint` and friends.
pack-priv String	docrootParent() Argument for command-line option `-Xdocrootparent`.
pack-priv String	docTitle() Argument for command-line option `-doctitle`.
public Set<? extends BaseOptions.Option>	getSupportedOptions() Overrides jdk.javadoc.internal.doclets.toolkit.BaseOptions.getSupportedOptions.
pack-priv String	header() Argument for command-line option `-header`.
public String	helpFile() Argument for command-line option `-helpfile`.
public String	legalNotices() Argument for command-line option `--legal-notices`.
public boolean	noDeprecatedList() Argument for command-line option `-nodeprecated`.
public boolean	noHelp() Argument for command-line option `-nohelp`.
public boolean	noNavbar() Argument for command-line option `-nonavbar`.
pack-priv boolean	noOverview() Argument for command-line option `-nooverview`.
pack-priv String	overviewPath() Argument for command-line option `-overview`.
pack-priv String	packagesHeader() Argument for command-line option `-packagesheader`.
pack-priv void	setCharset(String charset)
public void	setCreateOverview(boolean createOverview)
public boolean	showTaglets() Argument for command-line option `--show-taglets`.
public String	snippetPath() Argument for command-line option `--snippet-path`.
public boolean	splitIndex() Argument for command-line option `-splitindex`.
pack-priv String	stylesheetFile() Argument for command-line option `-stylesheetfile`.
public boolean	syntaxHighlight() Argument for command line option `--syntax-highlight`.
public String	tagletPath() Argument for command-line option `-tagletpath`.
pack-priv String	top() Argument for command-line option `-top`.
protected boolean	validateOptions()
pack-priv String	windowTitle() Argument for command-line option `-windowtitle`.

Field Detail

additionalScripts	back to summary
private List<String> additionalScripts Argument for command-line option `--add-script`.

additionalStylesheets	back to summary
private List<String> additionalStylesheets Argument for command-line option `--add-stylesheet`.

bottom	back to summary
private String bottom Argument for command-line option `-bottom`.

charset	back to summary
private String charset Argument for command-line option `-charset`. The META charset tag used for cross-platform viewing.

classUse	back to summary
private boolean classUse Argument for command-line option `-use`. True if command-line option "-use" is used. Default value is false.

config	back to summary
private HtmlConfiguration config Hides jdk.javadoc.internal.doclets.toolkit.BaseOptions.config.

createIndex	back to summary
private boolean createIndex Argument for command-line option `-noindex`. False if command-line option "-noindex" is used. Default value is true.

createOverview	back to summary
private 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.

createTree	back to summary
private boolean createTree Argument for command-line option `-notree`. False if command-line option "-notree" is used. Default value is true.

customTagStrs	back to summary
private final LinkedHashSet<List<String>> customTagStrs Arguments for command-line option `-tag` and `-taglet`.

doclintOpts	back to summary
private List<String> doclintOpts Arguments for command-line option `-Xdoclint` and friends. Collected set of doclint options.

docrootParent	back to summary
private String docrootParent Argument for command-line option `-Xdocrootparent`.

docTitle	back to summary
private String docTitle Argument for command-line option `-doctitle`.

header	back to summary
private String header Argument for command-line option `-header`.

helpFile	back to summary
private String helpFile Argument for command-line option `-helpfile`.

legalNotices	back to summary
private String legalNotices Argument for command-line option `--legal-notices`.

noDeprecatedList	back to summary
private boolean noDeprecatedList Argument for command-line option `-nodeprecatedlist`. True if command-line option "-nodeprecatedlist" is used. Default value is false.

noHelp	back to summary
private boolean noHelp Argument for command-line option `-nohelp`. True if command-line option "-nohelp" is used. Default value is false.

noNavbar	back to summary
private boolean noNavbar Argument for command-line option `-nonavbar`. True if command-line option "-nonavbar" is used. Default value is false.

noOverview	back to summary
private boolean noOverview Argument for command-line option `-nooverview`. True if command-line option "-nooverview" is used. Default value is false

overviewPath	back to summary
private String overviewPath Argument for command-line option `-overview`. The overview path specified with "-overview" flag.

packagesHeader	back to summary
private String packagesHeader Argument for command-line option `-packagesheader`.

showTaglets	back to summary
private boolean showTaglets Argument for command-line option `--show-taglets`. Show taglets (internal debug switch)

snippetPath	back to summary
private String snippetPath Argument for command-line option `--snippet-path`. The path for external snippets.

splitIndex	back to summary
private boolean splitIndex Argument for command-line option `-splitindex`. True if command-line option "-splitindex" is used. Default value is false.

stylesheetFile	back to summary
private String stylesheetFile Argument for command-line option `-stylesheetfile`.

syntaxHighlight	back to summary
private boolean syntaxHighlight Argument for command line option `--syntax-highlight`.

tagletPath	back to summary
private String tagletPath Argument for command-line option `-tagletpath`. The path to Taglets

top	back to summary
private String top Argument for command-line option `-top`.

windowTitle	back to summary
private String windowTitle Argument for command-line option `-windowtitle`.

Constructor Detail

HtmlOptions	back to summary
pack-priv HtmlOptions(HtmlConfiguration config)

Method Detail

additionalScripts	back to summary
pack-priv List<String> additionalScripts() Argument for command-line option `--add-script`.

additionalStylesheets	back to summary
pack-priv List<String> additionalStylesheets() Argument for command-line option `--add-stylesheet`.

bottom	back to summary
pack-priv String bottom() Argument for command-line option `-bottom`.

charset	back to summary
pack-priv String charset() Argument for command-line option `-charset`. The META charset tag used for cross-platform viewing.

classUse	back to summary
public boolean classUse() Argument for command-line option `-use`. True if command-line option "-use" is used. Default value is false.

createIndex	back to summary
public boolean createIndex() Argument for command-line option `-noindex`. False if command-line option "-noindex" is used. Default value is true.

createOverview	back to summary
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.

createTree	back to summary
public boolean createTree() Argument for command-line option `-notree`. False if command-line option "-notree" is used. Default value is true.

customTagStrs	back to summary
pack-priv LinkedHashSet<List<String>> customTagStrs() Arguments for command-line option `-tag` and `-taglet`.

doclintOpts	back to summary
pack-priv List<String> doclintOpts() Arguments for command-line option `-Xdoclint` and friends. Collected set of doclint options.

docrootParent	back to summary
pack-priv String docrootParent() Argument for command-line option `-Xdocrootparent`.

docTitle	back to summary
pack-priv String docTitle() Argument for command-line option `-doctitle`.

getSupportedOptions	back to summary
public Set<? extends BaseOptions.Option> getSupportedOptions() Overrides jdk.javadoc.internal.doclets.toolkit.BaseOptions.getSupportedOptions. Annotations @Override

getSupportedOptions

back to summary

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

Overrides jdk.javadoc.internal.doclets.toolkit.BaseOptions.getSupportedOptions.

Annotations

@Override

header	back to summary
pack-priv String header() Argument for command-line option `-header`.

helpFile	back to summary
public String helpFile() Argument for command-line option `-helpfile`.

legalNotices	back to summary
public String legalNotices() Argument for command-line option `--legal-notices`.

noDeprecatedList	back to summary
public boolean noDeprecatedList() Argument for command-line option `-nodeprecated`. True if command-line option "-nodeprecated" is used. Default value is false.

noHelp	back to summary
public boolean noHelp() Argument for command-line option `-nohelp`. True if command-line option "-nohelp" is used. Default value is false.

noNavbar	back to summary
public boolean noNavbar() Argument for command-line option `-nonavbar`. True if command-line option "-nonavbar" is used. Default value is false.

noOverview	back to summary
pack-priv boolean noOverview() Argument for command-line option `-nooverview`. True if command-line option "-nooverview" is used. Default value is false

overviewPath	back to summary
pack-priv String overviewPath() Argument for command-line option `-overview`. The overview path specified with "-overview" flag.

packagesHeader	back to summary
pack-priv String packagesHeader() Argument for command-line option `-packagesheader`.

setCharset	back to summary
pack-priv void setCharset(String charset)

setCreateOverview	back to summary
public void setCreateOverview(boolean createOverview)

showTaglets	back to summary
public boolean showTaglets() Argument for command-line option `--show-taglets`. Show taglets (internal debug switch)

snippetPath	back to summary
public String snippetPath() Argument for command-line option `--snippet-path`. The path for external snippets.

splitIndex	back to summary
public boolean splitIndex() Argument for command-line option `-splitindex`. True if command-line option "-splitindex" is used. Default value is false.

stylesheetFile	back to summary
pack-priv String stylesheetFile() Argument for command-line option `-stylesheetfile`.

syntaxHighlight	back to summary
public boolean syntaxHighlight() Argument for command line option `--syntax-highlight`. True if command line option "--syntax-highlight" is used and syntax highlighting should be enabled. Default value is false.

tagletPath	back to summary
public String tagletPath() Argument for command-line option `-tagletpath`. The path to Taglets

top	back to summary
pack-priv String top() Argument for command-line option `-top`.

validateOptions	back to summary
protected boolean validateOptions()

windowTitle	back to summary
pack-priv String windowTitle() Argument for command-line option `-windowtitle`.

public Class HtmlOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail