'\" t

.\" Copyright (c) 1994, 2015, Oracle and/or its affiliates. All rights reserved.

.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

.\"

.\" This code is free software; you can redistribute it and/or modify it

.\" under the terms of the GNU General Public License version 2 only, as

.\" published by the Free Software Foundation.

.\"

.\" This code is distributed in the hope that it will be useful, but WITHOUT

.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

.\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

.\" version 2 for more details (a copy is included in the LICENSE file that

.\" accompanied this code).

.\"

.\" You should have received a copy of the GNU General Public License version

.\" 2 along with this work; if not, write to the Free Software Foundation,

.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

.\"

.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

.\" or visit www.oracle.com if you need additional information or have any

.\" questions.

.\"

.\"     Arch: generic

.\"     Software: JDK 8

.\"     Date: 03 March 2015

.\"     SectDesc: Basic Tools

.\"     Title: javadoc.1

.\"

.if n .pl 99999

.TH javadoc 1 "03 March 2015" "JDK 8" "Basic Tools"

.\" -----------------------------------------------------------------

.\" * Define some portability stuff

.\" -----------------------------------------------------------------

.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.\" http://bugs.debian.org/507673

.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html

.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.ie \n(.g .ds Aq \(aq

.el       .ds Aq '

.\" -----------------------------------------------------------------

.\" * set default formatting

.\" -----------------------------------------------------------------

.\" disable hyphenation

.nh

.\" disable justification (adjust text to left margin only)

.ad l

.\" -----------------------------------------------------------------

.\" * MAIN CONTENT STARTS HERE *

.\" -----------------------------------------------------------------

.SH NAME    

javadoc \- Generates HTML pages of API documentation from Java source files\&.

.SH SYNOPSIS    

.sp     

.nf     

\fBjavadoc\fR {\fIpackages\fR|\fIsource\-files\fR} [\fIoptions\fR] [\fI@argfiles\fR]

.fi     

.sp     

.TP     

\fIpackages\fR

Names of packages that you want to document, separated by spaces, for example \f3java\&.lang java\&.lang\&.reflect java\&.awt\fR\&. If you want to also document the subpackages, use the \f3-subpackages\fR option to specify the packages\&.

By default, \f3javadoc\fR looks for the specified packages in the current directory and subdirectories\&. Use the \f3-sourcepath\fR option to specify the list of directories where to look for packages\&.

.TP     

\fIsource-files\fR

Names of Java source files that you want to document, separated by spaces, for example \f3Class\&.java Object\&.java Button\&.java\fR\&. By default, \f3javadoc\fR looks for the specified classes in the current directory\&. However, you can specify the full path to the class file and use wildcard characters, for example \f3/home/src/java/awt/Graphics*\&.java\fR\&. You can also specify the path relative to the current directory\&.

.TP     

\fIoptions\fR

Command-line options, separated by spaces\&. See Options\&.

.TP     

\fI@argfiles\fR

Names of files that contain a list of \f3javadoc\fR command options, package names and source file names in any order\&.

.SH DESCRIPTION    

The \f3javadoc\fR command parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages that describe (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields\&. You can use the \f3javadoc\fR command to generate the API documentation or the implementation documentation for a set of source files\&.

.PP

You can run the \f3javadoc\fR command on entire packages, individual source files, or both\&. When documenting entire packages, you can either use the \f3-subpackages\fR option to recursively traverse a directory and its subdirectories, or to pass in an explicit list of package names\&. When you document individual source files, pass in a list of Java source file names\&. See Simple Examples\&.

.SS PROCESS\ SOURCE\ FILES    

The \f3javadoc\fR command processes files that end in source and other files described in Source Files\&. If you run the \f3javadoc\fR command by passing in individual source file names, then you can determine exactly which source files are processed\&. However, that is not how most developers want to work, because it is simpler to pass in package names\&. The \f3javadoc\fR command can be run three ways without explicitly specifying the source file names\&. You can pass in package names, use the \f3-subpackages\fR option, or use wild cards with source file names\&. In these cases, the \f3javadoc\fR command processes a source file only when the file fulfills all of the following requirements:

.TP 0.2i    

\(bu

The file name prefix (with \f3\&.java\fR removed) is a valid class name\&.

.TP 0.2i    

\(bu

The path name relative to the root of the source tree is a valid package name after the separators are converted to dots\&.

.TP 0.2i    

\(bu

The package statement contains the valid package name\&.

.PP

Processing Links

During a run, the \f3javadoc\fR command adds cross-reference links to package, class, and member names that are being documented as part of that run\&. Links appear in the following places\&. See Javadoc Tags for a description of the @ tags\&.

.TP 0.2i    

\(bu

Declarations (return types, argument types, and field types)\&.

.TP 0.2i    

\(bu

\fISee Also\fR sections that are generated from \f3@see\fR tags\&.

.TP 0.2i    

\(bu

Inline text generated from \f3{@link}\fR tags\&.

.TP 0.2i    

\(bu

Exception names generated from \f3@throws\fR tags\&.

.TP 0.2i    

\(bu

\fISpecified by\fR links to interface members and \fIOverrides\fR links to class members\&. See Method Comment Inheritance\&.

.TP 0.2i    

\(bu

Summary tables listing packages, classes and members\&.

.TP 0.2i    

\(bu

Package and class inheritance trees\&.

.TP 0.2i    

\(bu

The index\&.

.PP

You can add links to existing text for classes not included on the command line (but generated separately) by way of the \f3-link\fR and \f3-linkoffline\fR options\&.

.PP

Processing Details

The \f3javadoc\fR command produces one complete document every time it runs\&. It does not do incremental builds that modify or directly incorporate the results from earlier runs\&. However, the \f3javadoc\fR command can link to results from other runs\&.

.PP

The \f3javadoc\fR command implementation requires and relies on the Java compiler\&. The \f3javadoc\fR command calls part of the \f3javac\fR command to compile the declarations and ignore the member implementations\&. The \f3javadoc\fR command builds a rich internal representation of the classes that includes the class hierarchy and use relationships to generate the HTML\&. The \f3javadoc\fR command also picks up user-supplied documentation from documentation comments in the source code\&. See Documentation Comments\&.

.PP

The \f3javadoc\fR command runs on source files that are pure stub files with no method bodies\&. This means you can write documentation comments and run the \f3javadoc\fR command in the early stages of design before API implementation\&.

.PP

Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code\&. For example, the \f3javadoc\fR command documents default constructors that are present in the compiled class files but not in the source code\&.

.PP

In many cases, the \f3javadoc\fR command lets you generate documentation for source files with incomplete or erroneous code\&. You can generate documentation before all debugging and troubleshooting is done\&. The \f3javadoc\fR command does primitive checking of documentation comments\&.

.PP

When the \f3javadoc\fR command builds its internal structure for the documentation, it loads all referenced classes\&. Because of this, the \f3javadoc\fR command must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes\&. See How Classes Are Found at http://docs\&.oracle\&.com/javase/8/docs/technotes/tools/findingclasses\&.html

.PP

Typically, classes you create must either be loaded as an extension or in the \f3javadoc\fR command class path\&.

.SS JAVADOC\ DOCLETS    

You can customize the content and format of the \f3javadoc\fR command output with doclets\&. The \f3javadoc\fR command has a default built-in doclet, called the standard doclet, that generates HTML-formatted API documentation\&. You can modify or make a subclass of the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you want\&.

.PP

When a custom doclet is not specified with the \f3-doclet\fR option, the \f3javadoc\fR command uses the default standard doclet\&. The \f3javadoc\fR command has several options that are available regardless of which doclet is being used\&. The standard doclet adds a supplementary set of command-line options\&. See Options\&.

.SH SOURCE\ FILES    

The \f3javadoc\fR command generates output that originates from the following types of source files: Java language source files for classes (\f3\&.java\fR), package comment files, overview comment files, and miscellaneous unprocessed files\&. This section also describes test files and template files that can also be in the source tree, but that you want to be sure not to document\&.

.SS CLASS\ SOURCE\ FILES    

Each class or interface and its members can have their own documentation comments contained in a source file\&. See Documentation Comments\&.

.SS PACKAGE\ COMMENT\ FILES    

Each package can have its own documentation comment, contained in its own source file, that the \f3javadoc\fR command merges into the generated package summary page\&. You typically include in this comment any documentation that applies to the entire package\&.

.PP

To create a package comment file, you can place your comments in one of the following files:

.TP 0.2i    

\(bu

The \f3package-info\&.java\fR file can contain the package declaration, package annotations, package comments, and Javadoc tags\&. This file is preferred\&.

.TP 0.2i    

\(bu

The \f3package\&.html\fR file contains only package comments and Javadoc tags\&. No package annotations\&.

.PP

A package can have a single \f3package\&.html\fR file or a single \f3package-info\&.java\fR file, but not both\&. Place either file in the package directory in the source tree with your source files\&.

.PP

The package-info\&.java File

The \f3package-info\&.java\fR file can contain a package comment of the following structure\&. The comment is placed before the package declaration\&.

.PP

\fINote:\fR The comment separators \f3/**\fR and \f3*/\fR must be present, but the leading asterisks on the intermediate lines can be left off\&.

.sp     

.nf     

\f3/**\fP

.fi     

.nf     

\f3 * Provides the classes necessary to create an  \fP

.fi     

.nf     

\f3 * applet and the classes an applet uses \fP

.fi     

.nf     

\f3 * to communicate with its applet context\&.\fP

.fi     

.nf     

\f3 * <p>\fP

.fi     

.nf     

\f3 * The applet framework involves two entities:\fP

.fi     

.nf     

\f3 * the applet and the applet context\&.\fP

.fi     

.nf     

\f3 * An applet is an embeddable window (see the\fP

.fi     

.nf     

\f3 * {@link java\&.awt\&.Panel} class) with a few extra\fP

.fi     

.nf     

\f3 * methods that the applet context can use to \fP

.fi     

.nf     

\f3 * initialize, start, and stop the applet\&.\fP

.fi     

.nf     

\f3 *\fP

.fi     

.nf     

\f3 * @since 1\&.0\fP

.fi     

.nf     

\f3 * @see java\&.awt\fP

.fi     

.nf     

\f3 */\fP

.fi     

.nf     

\f3package java\&.lang\&.applet;\fP

.fi     

.nf     

\f3\fP

.fi     

.sp     

.PP

The package\&.html File

The \f3package\&.html\fR file can contain a package comment of the following structure\&. The comment is placed in the \f3<body>\fR element\&.

.PP

File: \f3java/applet/package\&.html\fR

.sp     

.nf     

\f3<HTML>\fP

.fi     

.nf     

\f3<BODY>\fP

.fi     

.nf     

\f3Provides the classes necessary to create an applet and the \fP

.fi     

.nf     

\f3classes an applet uses to communicate with its applet context\&.\fP

.fi     

.nf     

\f3<p>\fP

.fi     

.nf     

\f3The applet framework involves two entities: the applet\fP

.fi     

.nf     

\f3and the applet context\&. An applet is an embeddable\fP

.fi     

.nf     

\f3window (see the {@link java\&.awt\&.Panel} class) with a\fP

.fi     

.nf     

\f3few extra methods that the applet context can use to\fP

.fi     

.nf     

\f3initialize, start, and stop the applet\&. \fP

.fi     

.nf     

\f3\fP

.fi     

.nf     

\f3@since 1\&.0 \fP

.fi     

.nf     

\f3@see java\&.awt\fP

.fi     

.nf     

\f3</BODY>\fP

.fi     

.nf     

\f3</HTML>\fP

.fi     

.nf     

\f3\fP

.fi     

.sp     

The \f3package\&.html\fR file is a typical HTML file and does not include a package declaration\&. The content of the package comment file is written in HTML with one exception\&. The documentation comment should not include the comment separators \f3/**\fR and \f3*/\fR or leading asterisks\&. When writing the comment, make the first sentence a summary about the package, and do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. You can include package tags\&. All block tags must appear after the main description\&. If you add an \f3@see\fR tag in a package comment file, then it must have a fully qualified name\&.

.PP

Processing the Comment File

When the \f3javadoc\fR command runs, it searches for the package comment file\&. If the package comment file is found, then the \f3javadoc\fR command does the following:

.TP 0.2i    

\(bu

Copies the comment for processing\&. For package\&.html, the \f3javadoc\fR command copies all content between the \f3<body>\fR and \f3</body>\fR HTML tags\&. You can include a \f3<head>\fR section to put a \f3<title>\fR tag, source file copyright statement, or other information, but none of these appear in the generated documentation\&.

.TP 0.2i    

\(bu

Processes the package tags\&. See Package Tags\&.

.TP 0.2i    

\(bu

Inserts the processed text at the bottom of the generated package summary page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html

.TP 0.2i    

\(bu

Copies the first sentence of the package comment to the top of the package summary page\&. The \f3javadoc\fR command also adds the package name and this first sentence to the list of packages on the overview page\&. See Java Platform, Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html

The end of the sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions\&.

.SS OVERVIEW\ COMMENT\ FILES    

Each application or set of packages that you are documenting can have its own overview documentation comment that is kept in its own source file, that the \f3javadoc\fR command merges into the generated overview page\&. You typically include in this comment any documentation that applies to the entire application or set of packages\&.

.PP

You can name the file anything you want such as overview\&.html and place it anywhere\&. A typical location is at the top of the source tree\&.

.PP

For example, if the source files for the \f3java\&.applet\fR package are contained in the /home/user/src/java/applet directory, then you could create an overview comment file at /home/user/src/overview\&.html\&.

.PP

You can have multiple overview comment files for the same set of source files in case you want to run the \f3javadoc\fR command multiple times on different sets of packages\&. For example, you could run the \f3javadoc\fR command once with \f3-private\fR for internal documentation and again without that option for public documentation\&. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file\&.

.PP

The content of the overview comment file is one big documentation comment that is written in HTML\&. Make the first sentence a summary about the application or set of packages\&. Do not put a title or any other text between the \f3<body>\fR tag and the first sentence\&. All tags except inline tags, such as an {\f3@link}\fR tag, must appear after the main description\&. If you add an \f3@see\fR tag, then it must have a fully qualified name\&.

.PP

When you run the \f3javadoc\fR command, specify the overview comment file name with the \f3-overview\fR option\&. The file is then processed similarly to that of a package comment file\&. The \f3javadoc\fR command does the following:

.TP 0.2i    

\(bu

Copies all content between the \f3<body>\fR and \f3</body>\fR tags for processing\&.

.TP 0.2i    

\(bu

Processes the overview tags that are present\&. See Overview Tags\&.

.TP 0.2i    

\(bu

Inserts the processed text at the bottom of the generated overview page\&. See Java Platform Standard Edition API Specification Overview at http://docs\&.oracle\&.com/javase/8/docs/api/overview-summary\&.html

.TP 0.2i    

\(bu

Copies the first sentence of the overview comment to the top of the overview summary page\&.

.SS UNPROCESSED\ FILES    

Your source files can include any files that you want the \f3javadoc\fR command to copy to the destination directory\&. These files usually include graphic files, example Java source and class files, and self-standing HTML files with a lot of content that would overwhelm the documentation comment of a typical Java source file\&.

.PP

To include unprocessed files, put them in a directory called doc-files\&. The doc-files directory can be a subdirectory of any package directory that contains source files\&. You can have one doc-files subdirectory for each package\&.

.PP

For example, if you want to include the image of a button in the \f3java\&.awt\&.Button\fR class documentation, then place the image file in the /home/user/src/java/awt/doc-files/ directory\&. Do not place the doc-files directory at /home/user/src/java/doc-files, because java is not a package\&. It does not contain any source files\&.

.PP

All links to the unprocessed files must be included in the code because the \f3javadoc\fR command does not look at the files\&. The \f3javadoc\fR command copies the directory and all of its contents to the destination\&. The following example shows how the link in the Button\&.java documentation comment might look:

.sp     

.nf     

\f3/**\fP

.fi     

.nf     

\f3 * This button looks like this: \fP

.fi     

.nf     

\f3 * <img src="doc\-files/Button\&.gif">\fP

.fi     

.nf     

\f3 */\fP

.fi     

.nf     

\f3\fP

.fi     

.sp     

.SS TEST\ AND\ TEMPLATE\ FILES    

You can store test and template files in the source tree in the same directory with or in a subdirectory of the directory where the source files reside\&. To prevent test and template files from being processed, run the \f3javadoc\fR command and explicitly pass in individual source file names\&.

.PP

Test files are valid, compilable source files\&. Template files are not valid, compatible source files, but they often have the \f3\&.java\fR suffix\&.

.PP

Test Files

If you want your test files to belong to either an unnamed package or to a package other than the package that the source files are in, then put the test files in a subdirectory underneath the source files and give the directory an invalid name\&. If you put the test files in the same directory with the source and call the \f3javadoc\fR command with a command-line argument that indicates its package name, then the test files cause warnings or errors\&. If the files are in a subdirectory with an invalid name, then the test file directory is skipped and no errors or warnings are issued\&. For example, to add test files for source files in com\&.package1, put them in a subdirectory in an invalid package name\&. The following directory name is invalid because it contains a hyphen:

.sp     

.nf     

\f3com/package1/test\-files/\fP

.fi     

.nf     

\f3\fP

.fi     

.sp     

If your test files contain documentation comments, then you can set up a separate run of the \f3javadoc\fR command to produce test file documentation by passing in their test source file names with wild cards, such as \f3com/package1/test-files/*\&.java\fR\&.

.PP

Template Files

If you want a template file to be in the source directory, but not generate errors when you execute the \f3javadoc\fR command, then give it an invalid file name such as \f3Buffer-Template\&.java\fR to prevent it from being processed\&. The \f3javadoc\fR command only processes source files with names, when stripped of the \f3\&.java\fR suffix, that are valid class names\&.

.SH GENERATED\ FILES    

By default, the \f3javadoc\fR command uses a standard doclet that generates HTML-formatted documentation\&. The standard doclet generates basic content, cross-reference, and support pages described here\&. Each HTML page corresponds to a separate file\&. The \f3javadoc\fR command generates two types of files\&. The first type is named after classes and interfaces\&. The second type contain hyphens (such as package-summary\&.html) to prevent conflicts with the first type of file\&.

.SS BASIC\ CONTENT\ PAGES    

.TP 0.2i    

\(bu

One class or interface page (classname\&.html) for each class or interface being documented\&.

.TP 0.2i    

\(bu

One package page (package-summary\&.html) for each package being documented\&. The \f3javadoc\fR command includes any HTML text provided in a file with the name package\&.html or package-info\&.java in the package directory of the source tree\&.

.TP 0.2i    

\(bu

One overview page (overview-summary\&.html) for the entire set of packages\&. The overview page is the front page of the generated document\&. The \f3javadoc\fR command includes any HTML text provided in a file specified by the \f3-overview\fR option\&. The Overview page is created only when you pass two or more package names into the \f3javadoc\fR command\&. See HTML Frames and Options\&.

.SS CROSS-REFERENCE\ PAGES    

.TP 0.2i    

\(bu

One class hierarchy page for the entire set of packages (overview-tree\&.html)\&. To view the hierarchy page, click \fIOverview\fR in the navigation bar and click \fITree\fR\&.

.TP 0.2i    

\(bu

One class hierarchy page for each package (package-tree\&.html) To view the hierarchy page, go to a particular package, class, or interface page, and click \fITree\fR to display the hierarchy for that package\&.

.TP 0.2i    

\(bu

One use page for each package (package-use\&.html) and a separate use page for each class and interface (class-use/classname\&.html)\&. The use page describes what packages, classes, methods, constructors and fields use any part of the specified class, interface, or package\&. For example, given a class or interface A, its use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A\&. To view the use page, go to the package, class, or interface and click the \fIUse\fR link in the navigation bar\&.

.TP 0.2i    

\(bu

A deprecated API page (deprecated-list\&.html) that lists all deprecated APIs and their suggested replacements\&. Avoid deprecated APIs because they can be removed in future implementations\&.

.TP 0.2i    

\(bu

A constant field values page (constant-values\&.html) for the values of static fields\&.

.TP 0.2i    

\(bu

A serialized form page (serialized-form\&.html) that provides information about serializable and externalizable classes with field and method descriptions\&. The information on this page is of interest to reimplementors, and not to developers who want to use the API\&. To access the serialized form page, go to any serialized class and click \fISerialized Form\fR in the See Also section of the class comment\&. The standard doclet generates a serialized form page that lists any class (public or non-public) that implements Serializable with its \f3readObject\fR and \f3writeObject\fR methods, the fields that are serialized, and the documentation comments from the \f3@serial\fR, \f3@serialField\fR, and \f3@serialData\fR tags\&. Public serializable classes can be excluded by marking them (or their package) with \f3@serial\fR exclude, and package-private serializable classes can be included by marking them (or their package) with an \f3@serial\fR include\&. As of Release 1\&.4, you can generate the complete serialized form for public and private classes by running the \f3javadoc\fR command without specifying the \f3-private\fR option\&. See Options\&.

.TP 0.2i    

\(bu

An index page (\f3index-*\&.html\fR) of all class, interface, constructor, field and method names, in alphabetical order\&. The index page is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A\(enZ for English)\&.

.SS SUPPORT\ PAGES    

.TP 0.2i    

\(bu

A help page (help-doc\&.html) that describes the navigation bar and the previous pages\&. Use \f3-helpfile\fR to override the default help file with your own custom help file\&.

.TP 0.2i    

\(bu

One index\&.html file that creates the HTML frames for display\&. Load this file to display the front page with frames\&. The index\&.html file contains no text content\&.

.TP 0.2i    

\(bu

Several frame files (\f3*-frame\&.html\fR) that contains lists of packages, classes, and interfaces\&. The frame files display the HTML frames\&.

.TP 0.2i    

\(bu

A package list file (package-list) that is used by the \f3-link\fR and \f3-linkoffline\fR options\&. The package list file is a text file that is not reachable through links\&.

.TP 0.2i    

\(bu

A style sheet file (stylesheet\&.css) that controls a limited amount of color, font family, font size, font style, and positioning information on the generated pages\&.

.TP 0.2i    

\(bu

A doc-files directory that holds image, example, source code, or other files that you want copied to the destination directory\&. These files are not processed by the \f3javadoc\fR command\&. This directory is not processed unless it exists in the source tree\&.

.PP

See Options\&.

.SS HTML\ FRAMES    

The \f3javadoc\fR command generates the minimum number of frames (two or three) necessary based on the values passed to the command\&. It omits the list of packages when you pass a single package name or source files that belong to a single package as an argument to the \f3javadoc\fR command\&. Instead, the \f3javadoc\fR command creates one frame in the left-hand column that displays the list of classes\&. When you pass two or more package names, the \f3javadoc\fR command creates a third frame that lists all packages and an overview page (overview-summary\&.html)\&. To bypass frames, click the \fINo Frames\fR link or enter the page set from the overview-summary\&.html page\&.

.SS GENERATED\ FILE\ STRUCTURE    

The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized\&. This structure is one directory per subpackage\&.

.PP

For example, the document generated for the \f3java\&.applet\&.Applet\fR class would be located at java/applet/Applet\&.html\&.

.PP

The file structure for the \f3java\&.applet\fR package follows, assuming that the destination directory is named \f3apidocs\fR\&. All files that contain the word \fIframe\fR appear in the upper-left or lower-left frames, as noted\&. All other HTML files appear in the right-hand frame\&.

.PP

Directories are bold\&. The asterisks (*) indicate the files and directories that are omitted when the arguments to the \f3javadoc\fR command are source file names rather than package names\&. When arguments are source file names, an empty package list is created\&. The doc-files directory is not created in the destination unless it exists in the source tree\&. See Generated Files\&.

.TP 0.2i    

\(bu

\fIapidocs\fR: Top-level directory

.RS     

.TP 0.2i    

\(bu

index\&.html: Initial Page that sets up HTML frames

.TP 0.2i    

\(bu

*overview-summary\&.html: Package list with summaries

.TP 0.2i    

\(bu

overview-tree\&.html: Class hierarchy for all packages

.TP 0.2i    

\(bu

deprecated-list\&.html: Deprecated APIs for all packages

.TP 0.2i    

\(bu

constant-values\&.html: Static field values for all packages

.TP 0.2i    

\(bu

serialized-form\&.html: Serialized forms for all packages

.TP 0.2i    

\(bu

*overview-frame\&.html: All packages for display in upper-left frame

.TP 0.2i    

\(bu

allclasses-frame\&.html: All classes for display in lower-left frame

.TP 0.2i    

\(bu

help-doc\&.html: Help about Javadoc page organization

.TP 0.2i    

\(bu

index-all\&.html: Default index created without \f3-splitindex\fR option

.TP 0.2i    

\(bu

\fIindex-files\fR: Directory created with \f3-splitindex\fR option

.RS     

.TP 0.2i    

\(bu

index-<number>\&.html: Index files created with \f3-splitindex\fR option

.RE     

.TP 0.2i    

\(bu

package-list: Package names for resolving external references

.TP 0.2i    

\(bu

stylesheet\&.css: Defines fonts, colors, positions, and so on

.RE     

.TP 0.2i    

\(bu

\fIjava\fR: Package directory

.RS     

.TP 0.2i    

\(bu

\fIapplet\fR: Subpackage directory

.RS     

.TP 0.2i    

\(bu

Applet\&.html: \f3Applet\fR class page

.TP 0.2i    

\(bu

AppletContext\&.html: \f3AppletContext\fR interface

.TP 0.2i    

\(bu

AppletStub\&.html: \f3AppletStub\fR interface

.TP 0.2i    

\(bu

AudioClip\&.html: \f3AudioClip\fR interface