Specifying the Default Javadoc Executor
You can perform the following actions on the Javadoc executor:
- Change the default Javadoc executor.
The external Javadoc executor is
the default executor at start up.
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, such as the JDK.
- Configure the properties of a Javadoc executor. The properties define the content and format of the Javadoc output,
including which doclet to use to generate the documentation.
- Create a custom Javadoc executor.
To change the default executor:
- From the main window, choose Tools
Options.
- In the Options window, expand the Code Documentation node
and select the Documentation subnode.
- Set the Javadoc Executor Type property to the executor you want
to use for generating Javadoc documentation.
To configure the properties of a Javadoc executor:
-
In the Options window, expand the Code Documentation node. Then
expand the Javadoc Executor node.
- Select an executor type and modify its properties to your preferred values.
For a brief description of a property, move the pointer over the property name. For
more detailed information on the properties, see
External Javadoc Executor or Internal Javadoc Executor.
To create a custom executor:
- In the Options window, right-click the Javadoc Executors node and choose New
 service type.
- In the wizard, enter a name for the executor and click Finish.
A node for the executor is added to the Options window.
-
Select the node and modify its properties to your preferred values.
Legal Notices