内容简介

本API文档是如何组织的

本API文档有很多分别连接到导航条上的相应条目的页面, 如下所述.

概述

概述 页面是本API文档的起始页，它给出了所有包的概述摘要的列表，该页面还包含了各个包的设置的总体描述.

包

每个包都有一张包含所有类与接口的列表的页面, 且各有一个内容摘要. 这个页面也可以包含四个目录:

接口 (italic)

类

异常

错误

类/接口

每个接口、类、内部接口、内部类都有其自己单独的页面. 每个页面都分为3部分：包括 类/接口的描述, 提要表, 详细的成员描述:

类的继承图表

直接子类

所有已知的子接口

所有已知的执行类

类/接口的声明

类/接口的描述

内部类概要

域摘要

构造器概要

方法概要

域的细节

构造器细节

方法细节

每一个提要实体都包含了该项目的细节部分的第一句话。 提要部分较为基本，而细节部分的描述是按照它们在源代码中出现的顺序组织的。这样就保持了程序员建立构架的逻辑分组。

用法

每一个文档中的包，类，接口等都有其自己的用法页面。这个页面包含了其本身、子类、域、作参数等各种用法和相关资料。

树 (类的层次结构)

所有的包都有其层次结构页面：类的层次。 它包含了接口、类的的列表，它们是按照层次结构组织的。

不提倡的 API

不提倡的API 页列出了所有的不再提倡使用的API . 对不提倡的 API 不再推荐使用的, 主要是由于改进, 而且用于替补的 API 也将给出. 不提倡使用的 API将在未来的执行中被屏弃.

索引

索引 中包含了一个按照字母顺序排列的所有的类，接口，域，方法，构造器等的列表。 上一个/下一个本联接可以带你到前一个或后一个类，接口，包，或相关页面。

有框架/无框架

该联接显示或隐藏HTML框架。所有的页面都可以用这两种方式显示。

文档截图