Java Reference
In-Depth Information
JDK 1.5 introduced two new tags that can be used anywhere within your document:
{@code
text
}
and
{@literal
text
}
. In both cases, the text will be displayed without interpre-
tation. For example, if your text was
<b>
, normally this would be interpreted as the HTML tag
to start bold text. However, using the tag
{@code <b>}
will result in the text
<b>
being displayed
as desired. The
{@code
text
}
tag will display the text in monotype font and
{@literal
text
}
will display the text in normal font.
Package-Level Documentation
Javadoc can also incorporate package documentation into the generated output, and create a
summary page for your overall submission. An example of the summary page is shown in
Figure 2-2.
Figure 2-2.
Sample summary page
To create package documentation, you will need to create a file named
package.html
in
each package directory. A simple example might look like this:
