Java Reference
In-Depth Information
There are several command-line options; I normally use
-author
and
-version
to get it to
include these items, and often
-link
to tell it where to find the standard JDK to link to.
Run
javadoc -help
for a complete list of options, or see the full documentation online at
Oracle's website
.
Figure 21-1
shows one view of the documentation that the class shown in
Example 21-1
generates when run as:
$
javadoc -author -version JavadocDemo.java
Figure 21-1. Javadoc in action
Be aware that one of the (many) generated files have the same name as the class, with the ex-
tension
.html
. If you are still using applets and have a sample HTML file to invoke it, and
generate javadoc in the source directory, the
.html
file is silently overwritten with the javadoc