Configuring the Javadoc Executor
See Also
The external Javadoc executor runs the Javadoc binary from the Java SDK.
To view or change the properties of the external Javadoc executor,
open the Options window, expand Code Documentation
Javadoc Executors, and
select External Javadoc.
You can set the following properties:
Properties
- 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 character encoding, such as EUCJIS/SJIS.
The IDE looks for encoding settings in the following order:
- In the Encoding property for the Javadoc executor
- The system's default encoding
For more information on the supported encodings, see:
http://java.sun.com/j2se/1.4/docs/guide/intl/encoding.doc.html
- 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.
- External Process. Sets the external process that the IDE uses to
generate documentation. Click the ellipsis (...) button to browse to a new
executable or to configure the arguments passed to the executor.
- Locale. Specifies the locale to use when generating documentation.
The locale consists of a language code and a country code. The language code
is written as a pair of lowercase letters, and the country code consists of
two uppercase letters. For example, you specify the French language and the
country of Canada as fr_CA.
- 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 value 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, generates Javadoc documentation for all subdirectories.
If False, generates Javadoc documentation for the selected folder only.
- Enable JDK 1.4 Source. If True, the executor accepts code containing
assertions. Assertions were introduced in JDK 1.4. If False, the executor
does not support assertions.
- 1.1 Style If True, generates the documentation with the same format
and functionality of documentation generated by the Javadoc 1.1 executor.
The pages use the following formats:
- A gray background
- Images for headers
- Bulleted lists instead of tables
- A flat destination directory structure
- An index split into separate files for each letter of the alphabet
- No inherited API, HTML frames, or inner classes
- Verbose. If True, provides more detailed messages while the Javadoc
executor is running.
Expert
- Start Heap Size.
Specifies the amount of memory the executor can use for a given process.
The default is 96 megabytes. For generating JDK Javadoc documentation, 256 megabytes is recommended.
Legal Notices