IntelliJ IDEA 2017.3 Help

Generate JavaDoc Dialog

Tools | Generate JavaDoc

This dialog invokes JavaDoc utility. The controls of the dialog box correspond to the options and tags of this utility.

ItemDescription
Generate JavaDoc scopeUse this area to specify the subset of files, folders, packages etc. for which JavaDoc should be generated.

This scope can be the whole project, uncommitted files (when VCS is enabled), current file, custom scope etc.

Include test sourcesSelect this checkbox to have the documentation comments for the test files included in 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. Refer to documentation for details.
If this checkbox is selected, the references to the classes, packages etc. from JDK will turn into links, which corresponds to using the -link option of the JavaDoc utiity.

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

Refer to JavaDoc documentation for details.

Output directoryIn this text box, specify the fully qualified path to the directory where the generated documentation will be stored. Type the path manually or click the Browse button /help/img/idea/2017.3/browseButton.png to open the Select Path dialog box where you can select the desired location. 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.

Note that unless the output directory is specified, the OK button is disabled.

SliderIn this area, specify the visibility level of members to be included in the generated documentation. The available options are:
  • Private - select this level to have all classes and members included. The level corresponds to the -private JavaDoc parameter.
  • Package - select this level to have all classes and members except private ones included. The level corresponds to the -package JavaDoc parameter.
  • Protected - select this level to have only public and protected classes and members included. The level corresponds to the -protected JavaDoc parameter.
  • Public - select this level to have only public classes and members included. The level corresponds to the -public JavaDoc parameter.
Generate hierarchy treeSelect this checkbox to have the class hierarchy generated. If this checkbox is cleared, the -notree parameter is passed to JavaDoc.
Generate navigator barSelect this checkbox to have the navigator bar generated. If this checkbox is cleared, the -nonavbar parameter is passed to JavaDoc.
Generate indexSelect this checkbox to have the documentation index generated. If this checkbox is cleared, the -noindex parameter is passed to JavaDoc.
Separate index per letterSelect this checkbox to have a separate index file for each letter generated. If this checkbox is cleared, the -splitindex parameter is passed to JavaDoc.

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

@useSelect this checkbox to have the use of class and package documented. When selected, the checkbox corresponds to the -use JavaDoc parameter.
@authorSelect this checkbox to have the @author paragraphs included. When selected, the checkbox corresponds to the -author JavaDoc parameter.
@versionSelect this checkbox to have the @version paragraphs included. When selected, the checkbox corresponds to the -version JavaDoc parameter.
@deprecatedSelect this checkbox to have the @deprecated information included. When the checkbox is cleared, the -nodeprecated parameter is passed to JavaDoc.
deprecated listSelect this checkbox to have the deprecated list generated. When the checkbox is cleared, the -nodeprecatedlist parameter is passed to JavaDoc.

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

LocaleIn this text box, type the desired locale.
Other command line argumentsIn this text box, type additional arguments to be passed to JavaDoc. Use the command line syntax.
Maximum heap size (Mb)In this text box, type the maximum heap size in Mb to be used by Java VM for running JavaDoc.
Open generated documentation in browserSelect this checkbox to have the generated JavaDoc automatically opened in the browser.
Last modified: 11 October 2017

See Also