Java Reference
In-Depth Information
-verbose
and
-quiet
These switches control how much output is produced as
javadoc
runs. If
you choose
-verbose
, detailed information is produced (more than the
default; in current versions, this option mostly shows time measurements
of the parsing of each source file). If you choose the
-quiet
option,
progress messages are suppressed completely.
-doclet
starting_class
We're not going to go into too much detail on this, but this switch allows
you to name a doclet (a class that uses the Doclet API) to use in place of
the default doclet. See the next paragraph for more information.
All of the switches documented so far are provided by the
javadoc
program
itself. Javadoc, like the rest of the Sun Microsystems Java SDK, is written in
Java. The authors of
javadoc
took advantage of this. The default behavior of
javadoc
is to produce HTML documentation with a standard look and feel.
However, there exists an API, called the Doclet API, which allows you to write
a Java class of your own to process the information parsed out of the source by
javadoc
. For details, see the Doclet Overview
3
on Sun's Web site.
Sun provides a default doclet that produces HTML documentation. That
doclet takes a number of command-line options as well. We'll cover the most
important of those now. Remember, these are provided by the standard doclet.
If you use the
-doclet
switch, then these switches will not be available (unless,
of course, the alternate doclet just happens to provide them).
-d
directory
By default, the HTML documentation is saved in the same directory as
the source. Use this switch to specify an alternate directory into which
documentation is to be placed.
-use
Causes
javadoc
to generate a “Use” page for each class and package. Such
a page is a cross-reference to all uses of the class or package.
-version
Causes any
@version
tag data to be included in the documentation. If
you are using CVS for source control (and why wouldn't you?) we
3.
http://java.sun.com/j2se/1.4.1/docs/tooldocs/javadoc/overview.html
