IntelliJ IDEA 14.0.0 Web Help

Generate JavaDoc Dialog

Tools | Generate JavaDoc

Item Description
Whole project Click this option to have JavaDoc generated for the entire project. This option is chosen by default if no package is selected in the Project View.
Package Click this option to have JavaDoc generated in a particular package. This option is chosen by default, if a specific package is selected in the Project View or the focus is in the editor.
Include subpackages Select this check box to have JavaDoc generated for the nested packages.

The check box is available only when the Package option is selected.

Output directory In 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 browseButton 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.
Slider In 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 tree Select this check box to have the class hierarchy generated. If this check box is cleared, the -notree parameter is passed to JavaDoc.
Generate navigator bar Select this check box to have the navigator bar generated. If this check box is cleared, the -nonavbar parameter is passed to JavaDoc.
Generate index Select this check box to have the documentation index generated. If this check box is cleared, the -noindex parameter is passed to JavaDoc.
Separate index per letter Select this check box to have a separate index file for each letter generated. If this check box is cleared, the -splitindex parameter is passed to JavaDoc.

The check box is available only if the Generate index check box is selected.

@use Select this check box to have the use of class and package documented. When selected, the check box corresponds to the -use JavaDoc parameter.
@author Select this check box to have the @author paragraphs included. When selected, the check box corresponds to the -author JavaDoc parameter.
@version Select this check box to have the @version paragraphs included. When selected, the check box corresponds to the -version JavaDoc parameter.
@deprecated Select this check box to have the @deprecated information included. When the check box is cleared, the -nodeprecated parameter is passed to JavaDoc.
deprecated list Select this check box to have the deprecated list generated. When the check box is cleared, the -nodeprecatedlist parameter is passed to JavaDoc.

The check box is available only if the @deprecated check box is selected.

Locale In this text box, type the desired locale.
Other command line arguments In 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 browser Select this check box to have the generated JavaDoc automatically opened in the browser.

See Also

Last modified: 4 December 2014
comments powered by Disqus