Generate JavaDoc Dialog
This dialog invokes JavaDoc utility. The controls of the dialog box correspond to the options and tags of this utility.
|Generate JavaDoc scope||Use 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 sources||Select this checkbox to have the documentation comments for the test files included in the generated JavaDoc.|
|Include JDK and library sources in ||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.|
|Include link to JDK documentation||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 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 to open the Select Path dialog box where you can select the desired location. The specified value is passed to the |
Note that unless the output directory is specified, the OK button is disabled.
|Slider||In this area, specify the visibility level of members to be included in the generated documentation. The available options are: |
|Generate hierarchy tree||Select this checkbox to have the class hierarchy generated. If this checkbox is cleared, the |
|Generate navigator bar||Select this checkbox to have the navigator bar generated. If this checkbox is cleared, the |
|Generate index||Select this checkbox to have the documentation index generated. If this checkbox is cleared, the |
|Separate index per letter||Select this checkbox to have a separate index file for each letter generated. If this checkbox is cleared, the |
The checkbox is available only if the Generate index checkbox is selected.
|@use||Select this checkbox to have the use of class and package documented. When selected, the checkbox corresponds to the |
|@author||Select this checkbox to have the |
|@version||Select this checkbox to have the |
|@deprecated||Select this checkbox to have the |
|deprecated list||Select this checkbox to have the deprecated list generated. When the checkbox is cleared, the |
The checkbox is available only if the @deprecated checkbox 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 checkbox to have the generated JavaDoc automatically opened in the browser.|