Table of Contents
dbdoclet provides a set of command-line options and a properties file. The command-line options overide the settings in the properties file. The command-line options are using the same names as the standard doclet to avoid major changes in existing scripts.
On Unix/Linux you can use the script dbdoclet as shortcut to
start javadoc with the correct -doclet and
-docletpath options.
The following list contains the javadoc options, which have a special behaviour in dbdoclet or a corresponding property name. For all other options consult the Javadoc documentation.
- dbdoclet -overview
path/filename Specifies the overview file. The contents of this file is used as the first chapter in the resulting document. Any h1 tag found in the overview file opens a new chapter. The title of the first chapter can be specified with the option
-doctitle, the default value is Overview.- dbdoclet -locale
language_country_variant Specifying a locale causes dbdoclet to use localized resources for all generated strings.
- dbdoclet -encoding
nameProperty:encoding.source Specifies the encoding of the source files, such as ISO-8859-1.