Specifying the Default Javadoc Executor

Generating documentation for large amounts of code (for example, the JDK) consumes a large amount of memory. 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. You can provide additional memory for the external Javadoc executor to use for a given process by setting its Start Heap Size property (on the Expert tab of its property sheet) to a higher value. The default is 96 megabytes; for generating of JDK Javadoc documentation, 256 megabytes is recommended.

To specify the default Javadoc executor:

  1. From the main window, choose Project Settings.
  2. In the Project Settings window, select the Documentation node.
  3. Set the Javadoc Executor Type property to the executor you want to use for generating Javadoc documentation. The default is the external Javadoc executor.

To customize a Javadoc executor:

  1. In the Project Settings window, expand the Javadoc Executors node.
  2. Select an executor and modify its properties to your preferred values.
To specify a custom executor, right-click the Javadoc Executors node and choose New service type. A node for the executor is added to the Project Settings window. Select the node and modify its properties to your preferred values.
See also
Configuring the External Javadoc Executor
Configuring the Internal Javadoc Executor
Specifying the Default Javadoc Search Engine
Modifying Doclet Properties

Legal Notices