Javadocs

JavaDoc Scope

Use this area to specify the subset of files, folders, and packages for which Javadoc should be generated.

This scope can be the whole project, recently modified files, current file, custom scope, and so on.

Include test sources

Include documentation comments for test to the generated Javadoc.

Include JDK and library sources in -sourcepath

If this checkbox is selected, then paths to the JDK and library sources will be passed to the Javadoc utility. For more information, refer to the Javadoc documentation.

Link to JDK documentation (use -link option)

If this checkbox is selected, the references to the classes and packages from JDK will turn into links, which corresponds to using the -link option of the Javadoc utility.

This checkbox is only enabled when a link to the online documentation is specified in the Documentation Paths tab of the SDK settings.

For more information, refer to the Javadoc documentation.

Output directory

Specify the fully qualified path to the directory where the generated documentation will be stored. Type the path manually or click Browse and select the location in the dialog. The specified value is passed to the -d parameter of the Javadoc utility. If the specified directory does not exist in your system, you will be prompted to create it.

Visibility level

Specify the visibility level of members that you want to include in the generated documentation:

• Public: include only public classes and members. The level corresponds to the -public Javadoc parameter.

• Protected: include only public and protected classes and members. The level corresponds to the -protected Javadoc parameter.

• Package: include all classes and members except the private ones. The level corresponds to the -package Javadoc parameter.

• Private: include all classes and members. The level corresponds to the -private Javadoc parameter.

Generate hierarchy tree

Generate the class hierarchy. If this checkbox is cleared, the -notree parameter is passed to Javadoc.

Generate navigator bar

Generate the navigator bar. If this checkbox is cleared, the -nonavbar parameter is passed to Javadoc.

Generate index

Generate the documentation index. If this checkbox is cleared, the -noindex parameter is passed to Javadoc.

Separate index per letter

Generate a separate index file for each letter. If this checkbox is cleared, the -splitindex parameter is passed to Javadoc.

The checkbox is available only if the Generate index checkbox is selected.

@use

Document the use of the class and the package. When selected, the checkbox corresponds to the -use Javadoc parameter.

@author

Include the @author paragraphs. When selected, the checkbox corresponds to the -author Javadoc parameter.

@version

Include the @version paragraphs. When selected, the checkbox corresponds to the -version Javadoc parameter.

@deprecated

Include the @deprecated information. When the checkbox is cleared, the -nodeprecated parameter is passed to Javadoc.

Deprecated list

Generate the deprecated list. When the checkbox is cleared, the -nodeprecatedlist parameter is passed to Javadoc.

The checkbox is available only if the @deprecated checkbox is selected.

Locale

Type the required locale.

Command line arguments

Type additional arguments to be passed to a Javadoc. Use the command line syntax.

Maximum heap size

Type the maximum heap size in Mb to be used by Java VM for running Javadoc.

Open generated documentation in browser

Automatically open the generated Javadoc in a browser.

Alignment

Define the way Javadoc comments should be aligned.

• Align parameter descriptions: align parameter descriptions against the longest parameter name. Otherwise, the description is separated from the corresponding parameter name by a single space.

• Align thrown exception descriptions: align thrown exception descriptions against the longest exception name. Otherwise, the description is separated from the exception name by a single space.

Blank lines

Define where blank lines should be inserted in Javadoc comments.

• After description: automatically insert a blank line after the description section of a Javadoc comment.

• After parameter descriptions: automatically insert a blank line after the group of @param tags.

• After return tag :automatically insert a blank line after the @return tag.

Invalid tags

In this area, define whether invalid tags should be preserved or not.

• Keep invalid tags: preserve the @invalidTag.

• Keep empty @param tags: preserve the @param tags without the description.

• Keep empty @return tags: preserve the @return tags without the description.

• Keep empty @throws tags: preserve the @throws tags without the description.

Other

In this area, specify additional formatting options for Javadoc comments.

• Enable leading asterisks: start each line of a Javadoc comment with an asterisk.

• Use @throws rather than @exception: use the @throws tag.

• Wrap at right margin: wrap the text that exceeds the right margin to the next line.

• Generate "<p>" on empty lines: automatically insert the </p> tag on an empty line.

• Keep empty lines: select this checkbox to have manually added empty lines preserved.

• Do not wrap one line comments: keep short comments on one line with the opening and closing tags.

• Preserve line feeds: if this checkbox is not selected (by default), line feeds are not preserved on reformatting. This is convenient when comments should be formatted within the boundaries of a paragraph, to occupy minimum space.

  If this checkbox is selected, line feeds will be preserved.

• Parameter descriptions on new line: place the description of a Javadoc parameter (if any) to a new line. It uses the indent based on the continuation indent value.

• Indent continuation lines: indent subsequent lines in multiline comments.