Javadoc Generation Command Line Tool

Use

Here you can find information about the Javadoc generation command line tool.

Starting the Tool

For more information, see Starting Command Line Tools .

Help

You can use the command help to obtain an overview of the existing commands. To display information about a specific command, enter help <command name> . This will show the command syntax and a short description of the command. You can get a printout with the full list of the commands and their parameters, arguments, and examples on their usage using the command help -x <location to export the commands>\JavadocGeneration.doc .

Commands and Options

Commands

List of Commands

Command Name	Description
jdar2html	Creates Javadoc HTML documentation for the given list of JDAR archives.
dcia2html	Creates Javadoc HTML documentation for the given list of *.dcia archives.
sca2html	Creates Javadoc HTML documentation for the given list of *.sca archives.
cbs	Opens a CBS subshell that allows to execute CBS.

Options of the Commands

This command line tool supports most of the options of the Standard doclet that comes with the javadoc command. Note that the notation of options may differ in some case, because this command follows the POSIX standard for shell tools. This means that options such as -group or -linkoffline with multiple arguments must be written in the form:

-option 'argument argument ...'

instead of

-option argument argument ...

Note the single quotation marks (') around the argument list. Arguments that contain white space or backslashes (\) must be enclosed in double quotation marks ("). This is important for operating systems that use backslashes as separators in paths. For example, when using the option to define destination directory (-d) on a Microsoft Windows system, you must enter the command as follows:

Example

-d "c:\Documents and Settings\user\javadoc"

List of Options for the Commands

Option Name	Description
failonerror / fail	Specifies whether the HTML generation should fail if an issue with at least -loglevel=warning is encountered. Otherwise, the generation continues and only the erroneous part is skipped. This option is not available for the Javadoc command.
loglevel	Specifies the level of logging details. Supported values are error , warning , info , verbose and debug . Default is info . This option is not available for the Standard doclet.
logfile	Specifies an additional log file. By default, all commands write log entries to the console. This option is not available for the Standard doclet.
malformed	If enabled, malformed Javadoc comments are marked with the label MALFORMED[...] in red letters in the generated Javadoc HTML. This helps when detecting unclosed HTML tags or malformed Javadoc tags, for example. This option is not available for the Standard doclet.
destdir / d	Specifies the destination directory for the Javadoc generation. If the path contains white space or backslashes (\), it must be enclosed in single (') or double-quotation marks ("). For more information, see the -d option of the Javadoc command. This option is mandatory.
annotations / withAnnotations	Enables the rendering of annotations for all symbols. By default, only annotations of annotations (meta-annotations) are rendered. Note, this option is not available for the Standard doclet.
author / withAuthors	Enables the rendering of @author tags. For more information, see the -author option of the Javadoc command.
archiveName / a	Specifies the name of the archive for generated HTML content. The default name is javadoc.zip . This option is not available for the Standard doclet.
bottom	Specifies the text to be rendered at the bottom of each output file. The value may contain HTML tags and white space, but must be enclosed in single (') or double-quotation marks (") in that case. For more information, see the -bottom option of the Standard doclet.
bottomStyle	Specifies a CSS style to be assigned to the bottom text. This option is not available for the Standard doclet.
buildID	Identifier of the JDoc2Html generator, for example, a release or build number. This information is rendered into an XML comment near the top of generated HTML output. This option is not available for the Standard doclet.
charset / docencoding	Specifies the HTML character set. Note that this tool makes no difference between -charset and -docencoding . For more information, see -charset option of the Standard doclet.
compress / c	Specifies that the generated HTML content should be compressed as a ZIP archive. The name of the archive can be specified with the -archiveName option (default is javadoc.zip ). The compression level can be set with the -compressLevel option. This option is not available for the Standard doclet.
compressLevel	Specifies the compression level of the ZIP archive with HTML content. Must be a number between 0 (no compression) and 9 (best compression). The default value is 5 (medium compression). This option is not available for the Standard doclet.
connect	Specifies the connection parameters for a given link destination. This option may be defined multiple times. Format: -connect '<extdocURL> [param=value][;param=value]' Note that the single quotation marks around the parameter list are required by the POSIX standard. If a parameter value contains white space or semicolons (;) it must be enclosed in double (") quotation marks. If an asterisk () is specified as <extdocURL> the connection settings are applied to all -link and -linkoffline options. Currently the following connection parameters are supported: proxy=<proxyHost>[:<proxyPort>] - the host/port of a proxy to use. timeout=<timeout-in-ms> - the timeout in milliseconds to wait for a response. If not explicitly set, <proxyPort> is assumed to be 80 for HTTP and 443 for HTTPS. This option is not available for the Standard doclet.
doctitle / title	Specifies the title to be placed near the top of the overview-summary.html file. The value may contain HTML tags and white space. Note that the deprecated -title option of the Standard doclet is not supported by this tool. For more information, see the -doctitle option of the Standard doclet.
doctitleStyle	Specifies a CSS style to be assigned to the document title text. This option is not available for the Standard doclet.
documentID	Specifies a document identifier to be rendered as HTML comment near the top of each generated Javadoc HTML file. The value must be a valid content of an XML <!-- --> tag. This option is not available for the Standard doclet.
footer	Specifies text to be rendered right to the lower navigation bar. The value of this option may contain HTML tags and white space. For more information, see the -footer option of the Standard doclet.
footerStyle	Specifies a CSS style to be assigned to the footer text. This option is not available for the Standard doclet.
group	Specifies a group of packages that belong together on the overview page. This option may be defined multiple times. Format: -group '<group-header> <package-pattern>[:<package-pattern>]' Note that the single quotation marks around the parameter list are required by the POSIX standard. If the <group-header> parameter contains white space, it must be enclosed in additional double quotation marks ("). For example: -group '"A header with blank" java.lang.:org.example' This parameter is placed in the table heading for the group on the overview-summary.html page. Each <package-pattern> denotes a package or, if it ends with an asterisk (), a set of packages, respectively. Note that a definition such as java.lang. matches only subpackages of java.lang , while java.lang* would also match java.lang itself. Packages that do not match any -group option are collected in a group named Other Packages . If no -group option is defined at all, all packages are collected in a single table named Packages . For more information, see the -group option of the Standard doclet.
header	Specifies the text to be rendered right to the upper navigation bar. The value may contain HTML tags and white space. For more information, see the -header option of the Standard doclet.
headerStyle	Specifies a CSS style to be assigned to the header text. This option is not available for the Standard doclet.
link	Specifies a link to existing Javadoc documentation. The given URL is resolved during HTML generation and either a .symbols file (preferred) or package-list file is downloaded and subsequently used to resolve symbols. This option may be defined multiple times. Format: -link <extdocURL> The parameter <extdocURL> must be a valid URL. Supported protocols are http:// , file:// , absolute or relative paths. Note that you can set connection parameters (for example, the proxy to use) with the -connect option. For more information, see the -link option of the Standard doclet.
linkoffline	Specifies a link to existing Javadoc documentation. In contrast to the -link option the location of the .symbols or package-list file can differ from the given link URL. This option may be defined multiple times. Format: -linkoffline '<extdocURL> <packagelistloc>' Note that the single quotation marks around the parameter list are required by the POSIX standard. Both parameters <extdocURL> and <packagelistloc> must be valid URLs. Supported protocols for both are http:// , file:// , absolute, or relative paths. Note that you can set connection parameters (for example, the proxy to use) with the -connect option. For more information, see the -linkoffline option of the Standard doclet.
locale	Specifies the locale for the generated HTML content. For more information, see the -locale option of the Standard doclet.
location	Specifies the target location for locally resolvable symbols in a .symbols file generated by this tool. Format: -location <extdocURL> The parameter <extdocURL> must be a valid URL. This option is not available for the Standard doclet.
maxIndexSize	Specifies the maximum number of index entries for a single-page global index. If the number of index entries exceeds -maxIndexSize the global index is split into multiple pages, that is, one index page per letter. This option is not available for the Standard doclet.
memberAnnotations / withMemberAnnotations	Enables the rendering of annotations for members of symbols. By default, only annotations of annotations (meta-annotations) are rendered. This option is not available for the Standard doclet.
noblanktarget / suppressBlankTarget	Suppresses the rendering of remote links with the attribute target="_blank" . This option is not available for the Standard doclet.
nocomment / suppressComments	Suppresses the rendering of javadoc comments. For more information, see the -nocomment option of the Standard doclet.
nocorbaobject / supressSubclassesOfCorbaObject	Suppresses the creation of an index with the subclasses of org.omg.CORBA.Object, because this index may become quite large. Note that this option is not available for the Standard doclet.
nodeprecatedlist / suppressDeprecatedList	Suppresses the rendering of the deprceated-list.html file. For more information, see the -nodeprecatedlist option of the Standard doclet.
noindex / suppressIndex	Suppresses the rendering of a global index and the corresponding Index link in the navigation bar. For more information, see the -noindex option of the Standard doclet.
nonavbar / suppressNavBars	Suppresses the rendering of navigation bars. For more information, see the -nonavbar option of the Standard doclet.
noobject / supressSubclassesOfObject	Suppresses the creation of an index with the subclasses of java.lang.Object, because this index may become quite large. This option is not available for the Standard doclet.
nosince / suppressSince	Suppresses the rendering of @since tags. For more information, see the -nosince option of the Standard doclet.
notree / suppressTree	Suppresses the rendering of class/interface hierarchy pages and the corresponding tree link in the navigation bar. For more information, see the -notree option of the Standard doclet.
overview	Specifies the path/file name of a file that should be used as overview-summary.html . For more information, see the -overview option of the Standard doclet.
plugin	Specifies the implementations of a plug-in interface, for example an implementation com.sap.tc.jdoc.symbols.Publisher or com.sap.tc.jdoc.html.taglet.ITaglet , respectively. This option can be declared multiple times. Format: -plugin '<schema> <classname> <implemented-interface-name>' Note that the single quotation marks around the parameter list are required by the POSIX standard. Both class name parameters must be fully qualified. This option is not available for the Standard doclet.
pluginPath	Specifies the classpath for all kinds of extensions (plug-ins). Format: -pluginPath <classpath-element> <classpath-element>]* If a classpath element contains white space or backslashes (\) the whole argument must be enclosed in single (') or double-quotation marks ("). This option is not available for the Standard doclet.
quiet / q	Suppresses non-error and non-warning log messages. Equivalent to -loglevel warning. For more information, see the -quiet option of the Javadoc command.
resources	Specifies additional resources to be copied to the resources directory of generated HTML Javadoc. The value of this option is a colon (:) separated list of individual resource files or directories containing resources. All files in a given directory are copied, but subdirectories are ignored. This option is not available for the Standard doclet.
splitindex	Specifies that the index should be split into multiple index pages regardless of the overall size of the index. For more information, see the -splitindex option of the Standard doclet.
stylesheetfile	Specifies the path and file name of an alternative CSS stylesheet file replacing the built-in styles.css file. For more information, see the -stylesheetfile option of the Standard doclet.
suppress	Specifies a comma-separated list of suppress options. Supported values are: blanktarget (equivalent to -noblanktarget) comments (equivalent to -nocomments) deprecatedlist (equivalent to -nodeprecatedlist) index (equivalent to -noindex) navbar (equivalent to -nonavbar) since (equivalent to -nosince) corbaobject (equivalent to -nocorbaobject) object (equivalent to -noobject) tree (equivalent to -notree)
symbolsOnly	Suppresses the generation of HTML, but only merges the provided .symbols file into one aggregated .symbols file. This option is not available for the Standard doclet.
timestamp / withTimestamp	Enables the rendering of a timestamp in an XML comment near the top of the generated HTML content. By default, this option is switched off to avoid unnecessary rebuilds of dependant components in build environments that use hashes to track changes. This option is not available for the Standard doclet.
verbose / v	Provides detailed information about the generation process. Equivalent to option -loglevel verbose. For more information, see the -verbose option of the Javadoc command.
version / withVersions	Enables the rendering of @version tags. For more information, see the -version option of the Standard doclet.
windowtitle	Specifies the title to be placed in the HTML <title> tag. The value of this option should not contain HTML tags since some browsers do not render that correctly. For more information, see the -windowtitle option of the Standard doclet.