Configuring the External Javadoc Executor

The external Javadoc executor is the default executor. Using the external Javadoc executor is recommended over using the internal Javadoc executor because you are less likely to get an out of memory error when generating documentation for large amounts of code (for example, the JDK).

You can configure the external Javadoc executor, including increasing its memory usage, under the Javadoc Executors node in the Project Settings window. When you change the value of a property, your change affects all classes that use that executor. Following are descriptions of the executor properties.

Properties tab
1.1 If True, generates the documentation so that it has the same format and functionality of documentation generated by the Javadoc 1.1 executor. The pages will have a gray background, use images for headers, have bulleted lists instead of tables, and have a flat destination directory structure. These pages will not contain inherited API, will not use HTML frames, and will not support inner classes. This property also splits the index into separate files for each letter of the alphabet.
Doclets Specifies the doclet to use to generate the documentation. The doclet defines the page content and formats the output. By default, the external Javadoc executor uses the standard doclet for generating HTML pages.
Encoding Specifies the encoding name of the source files, such as EUCJIS/SJIS.
Extdirs Specifies the directories where extension classes reside. These classes use the Java Extension mechanism. The extdirs is part of the filesystem that the Javadoc executor uses to look up source and class files.
Locale Specifies the locale that javadoc uses when generating documentation, such as en_US (English, United States).
Members Specifies which members to include in the generated documentation. The choices are protected, public, package, and private. Protected shows protected and public classes and members. This is the default. Public shows public classes and members. Package shows package, protected, and public classes and members. Private shows all classes and members.
Overview Specifies the file from which the Javadoc executor should retrieve the text for the overview documentation. This file is typically named overview.html and placed at the top level of the source tree.
Recursive If True, creates recursively over directories.
Verbose If True, provides more detailed messages while the Javadoc executor is running.
Expert tab
Start Heap Size The amount of memory the executor can use for a given process. The default is 96 megabytes. For generating of JDK Javadoc documentation, 256 megabytes is recommended
See also
Configuring the Internal Javadoc Executor

Legal Notices