Internal Javadoc Executor
Using the internal Javadoc executor is not recommended when
generating documentation for large amounts of code, such as the
JDK. Running the Javadoc executor internally consumes a lot of memory.
To view or change the properties of the internal Javadoc executor,
open the Options window, expand the Code Documentation, expand the Javadoc Executors subnode, and
select Internal Javadoc. When you change the value of a property, your
change affects all files that use the internal Javadoc executor.
The Properties tab of the internal Javadoc executor contains the following properties.
- 1.1.
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
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.
For more information on the supported encodings, visit the Sun Microsystems
web page at http://java.sun.com/j2se/1.3/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.
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.
Verbose.
If True, provides more detailed messages while the Javadoc executor is running.
Legal Notices