Java Reference
In-Depth Information
recommend adding
$Id$
after the version tag, which CVS will automati-
cally replace by its ID string containing the filename, CVS revision num-
ber, date/time and the author of last check-in. (For more about CVS, see
Chapter 8.)
-author
Causes any
@author
tag data to be included in the documentation.
-splitindex
Causes the alphabetical index to be broken into multiple pages, one per
letter. Can be useful when you have a very large number of classes and/or
packages documented in a single Javadoc document set.
-windowtitle
title
Sets the title for the document set. The text that follows this switch will
go into the HTML
<title>
element on documentation pages.
-nodeprecated
This causes all deprecated methods and classes to go undocumented.
Normally they are documented, but marked as deprecated.
-nodeprecatedlist
Drops deprecated classes and methods from indexes, lists, and cross-
references, but leaves the actual documentation in place.
There are actually many more switches. Some of the most important that
we haven't covered are the
-link
,
-linkoffline
, and related tags. If you end
up producing many API packages and document them separately, you can use
these switches to link your separate Javadoc documentation together seamlessly,
so that when you use classes from separately documented packages, the refer-
ences in the documentation for your code will be live links to that separate
documentation. For details on these and other switches, see the Sun
documentation on
javadoc
.
4
4.
http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html
