Javadoc Documentation Generator - Java Software Solutions: Foundations of Program Design - page 701

Index provides an alphabetical listing of classes, constructors, and methods
in the package. The class name is also associated with a short purpose and
description of the class. Each appearance of the class name is a link to the
appropriate HTML documentation. The signature of every constructor and
method is a link to the appropriate detailed description. A one-sentence
description presented next to the signature listing associates the constructor/
method with the appropriate class.

■

Help loads a help page with how-to instructions for using and navigating
the HTML documentation.
All pages could be viewed with or without frames. Each class summary has
links that can be used to quickly access any of the parts of the document (as
described above).
The output content could be somewhat generated by command-line options
(see above) used when executing the javadoc tool. By default, if no options are
specified, the output returned is equivalent to using the −protected option. The
options include:

■

■ private shows all classes, methods, and variables.
■ public shows only public classes, methods, and variables.
■ protected shows only protected and public classes, methods, and
variables.
■ help presents the online help.
■ keywords includes HTML meta tags to the output file generated to assist
with searching.