Javadoc Options

com.sap.javadoc.standard.annotations

on|off

(default: off ) Enables the rendering of annotations for all symbols. By default, only annotations of annotations (meta-annotations) are rendered. See also com.sap.javadoc.standard.memberAnnotations.

This option is not available for the Standard doclet.

com.sap.javadoc.standard.author

on|off

Enables the rendering of @author tags.

For more information, see the -author option of the Javadoc command.

com.sap.javadoc.standard.bottom

Specifies text to be rendered at the bottom of each output file. The value may contain HTML tags and white space.

Example:

com.sap.javadoc.standard.bottom=&copy; <i>EXAMPLE.ORG</i>

renders a copyright symbol followed by a text in italics.

For more information, see the -bottom option of the Standard doclet.

com.sap.javadoc.standard.bottomStyle

Specifies a CSS style to be assigned to the bottom text. Note that this option is not available for the Standard doclet.

Example:

com.sap.javadoc.standard.bottomStyle=color:#04357B;

renders the bottom text in blue.

This option is not available for the Standard doclet.

com.sap.javadoc.standard.charset

(default: UTF-8) Specifies the HTML character set. Note that the charset determines the encoding of the generated HTML files, as well as the charset parameter of the Content-Type meta tag in the generated HTML documents.

For more information, see -charset and -docencoding options of the Standard doclet.

com.sap.javadoc.standard.connect

Specifies the connection parameters for a given link destination. This option may be defined multiple times. Format:

com.sap.javadoc.standard.connect.X=<extdocURL> [param=value][;param=value]*

where X is a number (starting with 1). If there is only one connect option, the number can be omitted. 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

Examples:

com.sap.javadoc.standard.connect=* proxy=proxy:1080;timeout=1000 com.sap.javadoc.standard.connect=http://help.sap.com/javadoc proxy=proxy:1080;timeout=1000

defines the proxy (proxy:1080) and timeout (1 second) for all connections (*) or connections to http://help.sap.com/javadoc, respectively. 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.

com.sap.javadoc.standard.doctitle

Specifies the title to be placed near the top of the overview-summary.htm l 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.

com.sap.javadoc.standard.doctitleStyle

Specifies a CSS style to be assigned to the document title text.

This option is not available for the Standard doclet.

com.sap.javadoc.standard.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 <!-- --> comment tag.

This option is not available for the Standard doclet.

com.sap.javadoc.standard.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.

com.sap.javadoc.standard.footerStyle

Specifies a CSS style to be assigned to the footer text.

This option is not available for the Standard doclet.

com.sap.javadoc.standard.group

Specifies a group of packages that belong together and that should be rendered in a separate table on the overview-summary page. This option may be defined multiple times.

Format:

com.sap.javadoc.standard.group.X=<group-header> <package-pattern>[:<package-pattern>]*

where X is a number (starting with 1).

If there is only one group option, the number can be omitted. The <group-header> is rendered as a table heading for a group on the overview-summary.html page. If it contains white space, it must be enclosed in double quotation marks ("). 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, all packages are collected in a single table named Packages .

Example:

com.sap.javadoc.standard.group="A header with blank" java.lang.*:org.example*

would render a table with the header A header with blank containing all symbols in subpackages of java.lang (but not symbols in java.lang itself, such as java.lang.String ), and all symbols in package example.org and all of its subpackages.

For more information, see the -group option of the Standard doclet.

com.sap.javadoc.standard.header

Specifies 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.

com.sap.javadoc.standard.headerStyle

Specifies a CSS style to be assigned to the header text.

This option is not available for the Standard doclet.

com.sap.javadoc.standard.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:

com.sap.javadoc.standard.link.X=<extdocURL>

where X is a number (starting with 1). If there is only one link option, the number can be omitted. The parameter <extdocURL> must be a valid URL.

Only the protocols http:// and file:// are supported. Note that it is possible to set connection parameters (for example, the proxy to use) with the connect option.

Example:

com.sap.javadoc.standard.link=http://java.sun.com/j2se/1.5.0/docs/api

would link the generated Javadoc to the Javadoc of JDK5.

For more information, see the -link option of the Standard doclet.

com.sap.javadoc.standard.linkoffline

Specifies a link to existing Javadoc documentation. In contrast to the link option, the location of the .symbols or package-list file required to resolve links to third-party can differ from the given link URL. In particular, this option can be used to reference the checked-in package list or .symbols files in a DC using the tc/bi/jdoctech build plug-in extension to collect JDAR archives from various other DCs and to generate HTML Javadoc out of it. This option may be defined multiple times.

Format:

com.sap.javadoc.standard.linkoffline.X=<extdocURL> <packagelistloc>

where X is a number (starting with 1). If there is only one linkoffline option, the number can be omitted. The parameter <extdocURL> must be a valid URL for which the JDK has a suitable protocol handler. Common protocols are http:// , https:// , and file:// . The parameter <packagelistloc> must be a path relative to one of the declared package folders of the current DC and end with either package-list or .symbols , or it must be an absolute path or a file share.

Example:

com.sap.javadoc.standard.linkoffline=http://java.sun.com/j2se/1.5.0/docs/api api/package-list

would search for a subfolder api in all packages folders of a DC for the file package-list and use that to resolve links to http://java.sun.com/j2se/1.5.0/docs/api .

For more information, see the -linkoffline option of the Standard doclet.

com.sap.javadoc.standard.locale

Specifies the locale for the generated HTML content.

For more information, see the -locale option of the Standard doclet.

com.sap.javadoc.standard.location

Specifies the target location for locally resolvable symbols in a .symbols file generated by this tool.

Format:

com.sap.javadoc.standard.location=<extdocURL>

The parameter <extdocURL> must be a valid URL for which the JDK has a suitable protocol handler. Common protocols are http:// , https:// , and file:// .

This option is not available for the Standard doclet.

com.sap.javadoc.standard.malformed

true|false

(default: off ) If enabled, malformed Javadoc comments are marked with the label MALFORMED[...] in red in the generated Javadoc HTML. This helps with detecting unclosed HTML tags or malformed Javadoc tags, for example.

This option is not available for the Standard doclet.

com.sap.javadoc.standard.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.

com.sap.javadoc.standard.memberAnnotations

on|off

(default: off ) Enables the rendering of annotations for members of symbols. By default, only annotations of annotations (meta-annotations) are rendered. See also: com.sap.javadoc.standard.annotations.

This option is not available for the Standard doclet.

com.sap.javadoc.standard.noblanktarget

on|off

(default: off ) Suppresses the rendering of remote links with the attribute target="_blank" .

This option is not available for the Standard doclet.

com.sap.javadoc.standard.nocomment

on|off

(default: off ) Suppresses the rendering of javadoc comments.

For more information, see the -nocomment option of the Standard doclet.

com.sap.javadoc.standard.nodeprecatedlist

on|off

(default: off ) Suppresses the rendering of the deprecated-list.html file.

For more information, see the -nodeprecatedlist option of the Standard doclet.

com.sap.javadoc.standard.noindex

on|off

(default: off ) 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.

com.sap.javadoc.standard.nonavbar

on|off

Suppresses the rendering of navigation bars.

For more information, see the -nonavbar option of the Standard doclet.

com.sap.javadoc.standard.nosince

on|off

(default: off ) Suppresses the rendering of @since tags.

For more information, see the -nosince option of the Standard doclet.

com.sap.javadoc.standard.notree

on|off

(default: off ) 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.

com.sap.javadoc.standard.overview

Specifies the path/file name of a file that should be used as overview-summary.htm l. The given path must be relative to one of the declared source or package folders of the current DC.

For more information, see the -overview option of the Standard doclet.

com.sap.javadoc.standard.pluginDCPath

Specifies a semi-colon (;) separated list of public parts (purpose infrastructure ) that contain taglet implementations.

Format:

com.sap.javadoc.standard.pluginDCPath=<pp-reference>[;<pp-reference]*

where <pp-reference> must be of the form <vendor>/<name>:<public-part-name> .

Example:

com.sap.javadoc.standard.taglet=org.example.taglets.TodoTaglet com.sap.javadoc.standard.pluginDCPath=example.org/common/taglets:def

would search for a taglet class with name org.example.taglets.TodoTaglet in the public part def of DC example.org/common/taglets . Note that the referenced public parts must declare the purpose infrastructure , so that they can be loaded by the build plug-in runtime. Suitable containers for taglets are DCs of type Build Infrastructure Extension that define the necessary infrastructure public part out of the box, but otherwise can be developed like ordinary Java Libraries.

com.sap.javadoc.standard.resources

Specifies additional resources to be copied to the resources directory of generated HTML Javadoc. The value of this property 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.

Format:

com.sap.javadoc.standard.resources=<path-or-file>[:<path-or-file>]*

where <path-or-file> denotes a file or a directory path relative to one of the declared source or package folders of the current DC.

This option is not available for the Standard doclet.com.sap.javadoc.standard

com.sap.javadoc.standard.splitindex

on|off

(default: off ) 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.

com.sap.javadoc.standard.stylesheetfile

Specifies the path/filen ame of an alternative CSS stylesheet file replacing the built-in styles.css file. The given path must be relative to one of the declared source or package folders of the current DC.

For more information, see the -stylesheetfile option of the Standard doclet.

com.sap.javadoc.standard.suppress

Specifies a comma-separated list of suppress options. Supported values are:

• blanktarget (equivalent to option noblanktarget )

• comments (equivalent to option nocomments )

• deprecatedlist (equivalent to option nodeprecatedlist )

• index (equivalent to option noindex )

• navbar (equivalent to option nonavbar )

• since (equivalent to option nosince )

• corbaobject (equivalent option nocorbaobject )

• tree (equivalent to -notree )

Example:

com.sap.javadoc.standard.suppress=navbar,index

would suppress the rendering of the navigation bars at the top and bottom of HTML pages and the global index.

com.sap.javadoc.standard.tag

Specifies the formatting options and placement for a custom taglet. This option may be defined multiple times.

Format:

com.sap.javadoc.standard.tag.X=<tag-name> <flags> "<caption>"

where X is a number (starting with 1). If there is only one tag option, the number can be omitted. The parameter <flags> defines where in the source code the tag can be used and must be a comma-separated list of the following tokens:

• all -- tag is allowed for all Java elements and for the overview page

• overview -- tag is allowed for the overview page

• packages -- tag is allowed in package.html and package-info.java files)

• types -- tag is allowed for symbols (classes, interfaces,...)

• constructors -- tag is allowed for constructors

• methods -- tag is allowed for methods

• fields -- tag is allowed for fields

• disable -- tag is disabled, that is, should not be rendered

The parameter <caption> defines the caption to render for tags of the given tag name. The value may contain HTML tags and white space, but must be included in double quotes (") in this case.

For more information, see the -tag option of the Standard doclet.

com.sap.javadoc.standard.taglet

Specifies the name of a taglet implementation. This option may be defined multiple times.

Format:

com.sap.javadoc.standard.taglet.X=<fully-qualified-class-name>

where X is a number (starting with 1). If there is only one taglet option, the number can be omitted. For more information about developing and integrating custom taglets into the DC build environment, see the com.sap.javadoc.standard.pluginDCPath option.

For more information about taglets and the taglet API in general, see the documentation of the Standard doclet.

com.sap.javadoc.standard.version

on|off

(default: off ) Enables the rendering of @version tags.

For more information, see the -version option of the Standard doclet.

com.sap.javadoc.standard.windowtitle

Specifies the title to be placed in the HTML <title> tag.

For more information, see the -windowtitle option of the Standard doclet.

com.sap.javadoc.loglevel

debug|verbose|info|warning|error

(default: info ) Specifies the level of logging details.

com.sap.javadoc.quiet

on|off

(default: off ) Suppresses non-error and non-warning log messages. Equivalent to com.sap.javadoc.loglevel=warning .

For more information, see the -quiet option of the Javadoc command.

com.sap.javadoc.verbose

on|off

(default: off ) Provides detailed information about the generation process. Equivalent option com.sap.javadoc.loglevel=verbose .

For more information, see the -verbose option of the Javadoc command.

com.sap.javadoc.failonerror

on|off

(default: off ) Specifies whether the build should fail with a build error, if an issue with at least loglevel=warning is encountered. Otherwise, the generation continues and only the erroneous part is skipped.

com.sap.javadoc.access

public|protected|package|private

(default: protected ) Specifies the access modifier Java symbols and members must at least be included in the generated Javadoc documentation.

Example:

com.sap.javadoc.access=package

advises the Javadoc compiler to show only package private , protected , and public symbols and members. This option maps to the -public , -protected , -package , and -private options of the Javadoc command.

com.sap.javadoc.breakiterator

on|off

(default: off ) Enables the usage of java.text.BreakIterator for the extraction of the first line of Javadoc comments.

For more information, see the -breakiterator option of the Javadoc command.

com.sap.javadoc.encoding

(default: UTF-8 ) Specifies the encoding of source files.

For more information, see the -encoding option of the Javadoc command.

com.sap.javadoc.formats

(default: standard ) Specifies the output formats to be produced by the SAP's Javadoc doclet. The value of this option is a comma-separated list of the constants:

• jdar - generates JDAR archives that are the prerequisite for producing HTML Javadoc for larger software units, such as software components

• html - uses an enhanced HTML generator to produce HTML Javadoc

• classic - uses the Standard doclet provided with the JDK to generate HTML Javadoc

The value standard is a shortcut for the combination jdar,html and is the default one. Note that html and classic cannot be used together, and classic is ignored in that case. If using formats=html , the generated HTML Javadoc may differ from that generated by the Standard doclet and some options may behave differently (for example, -tag , -link , -linkoffline ). This is not a defect, but a consequence of the innovative manner of producing Javadoc supported by the SAP's Javadoc doclet.

If compatibility is a major concern, formats=classic should be used. The SAP's Javadoc doclet then forks to the Standard doclet internally and the generated HTML is that of the Standard doclet. Note, however, that the output produced by the Standard doclet for a certain DC comprises only symbols contained in that DC, and it is not possible to aggregate Javadoc from multiple DCs. This is a consequence of developing in a component model: components expose binary artifacts (for example, public part archives), not source code. This is not specific to the SAP's DC model, but is usually considered to be a central ingredient of any design time component model. However, binary artifacts no longer contain Javadoc comments, so the Javadoc compiler has nothing to compile. The SAP's Javadoc doclet circumvents this problem by producing an intermediate Javadoc format (JDAR archives analog to JAR archives) that can be collected from multiple DCs and be used to generate HTML Javadoc independently of the build of those DCs. A dedicated HTML generator included in the SAP Javadoc doclet (and the tc/bi/jdoctech plugin) is necessary to facilitate the conversion.

com.sap.javadoc.maxmemory

Specifies the maximum heap size for the Javadoc tool and the doclet.

For more information, see the -Xmx JVM parameter.

com.sap.javadoc.source

Specifies the version of the source code accepted.

For more information, see -source option of the Javadoc command.

com.sap.javadoc.archiveName

(default: "javadoc.zip" ) Specifies the name of the archive for the generated HTML content.

com.sap.javadoc.compress

on|off

(default: off ) 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.

com.sap.javadoc.compressLevel

0..9

(default: 5 ) Specifies the compression level of the ZIP archive with HTML content. Must be a number between 0 (no compression) and 9 (best compression).

com.sap.javadoc.javadocPP

(default: "javadoc" ) Specifies the name of a public part to use as the destination for the generated Javadoc HTML content. If this option is not specified, the build plug-in searches for an assembly public part with name javadoc .

com.sap.javadoc.resourcepath

(default: "javadoc" ) Specifies the path prefix of generated Javadoc HTML output in a WAR archive.

com.sap.javadoc.standalone

on|off

(default: off ) Specifies that a standalone Javadoc archive should be generated and copied to the public part specified with the javadocPP option.