How This API Document Is Organized
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
Overview
The Overview page is the front page of this API document and provides a list of all top-level packages, classes, traits and objects with a summary for each. This page can also contain an overall description of the set of packages.
Package
Each package has a page that contains a list of its objects, traits and classes, with a summary for each. This page can contain three categories:
Object/Trait/Class
Each object, trait, class, nested object, nested trait and nested class has its own separate page. Each of these pages has three sections consisting of a object/trait/class description, summary tables, and detailed member descriptions: Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
Index
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
This help file applies to API documentation generated using the standard doclet.