Java Reference
In-Depth Information
<!doctype HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title>com.example.db</title>
</head>
<body>
Provides database functionality.
<h2>Package Specification</h2>
These classes are the base that provide the basic data creation, reading, updating,
and deleting functions required to process data in a database. Basic locking
functionality exists, but this is not an advanced package.
@author Unattributed person from example.com.
@author Andrew Monkhouse
@version 1.0
@since 1.0
</body>
</html>
JDK 5 Changes
The obvious changes to the Javadoc tool from earlier versions include support for the two new
tags (
{@code
text
}
and
{@literal
text
}
) mentioned earlier, and the obvious support for the
generics, enums, and VarArgs features.
When JDK 1.4 was released, Sun was planning to change the way Javadoc would deter-
mine how much of a comment should appear in the summary (where the break should be
between the summary and the remainder of the comment). Sun incorporated the logic for the
new break iterator in the Javadoc tool, which resulted in large numbers of warnings being gen-
erated when the proposed change would cause different summaries to appear in the future
version. Sun has now reversed their plans, and removed the 1.4 logic.
Running Javadoc from the Command Line
The basic command format for Javadoc is
javadoc [options] [packagenames] [sourcefiles] [@files]
Following from this, you could generate the API documentation for all your source files
that do not belong to any package by typing the following command in the same directory as
the source files:
javadoc *java
If you have your source files organized in packages, you could list the package names on
the command line instead:
javadoc com.example.mypackage com.example.more.packages
