# APIドキュメントの構成

このAPI (Application Programming Interface)ドキュメントには、次に説明するナビゲーション・バーにある項目に対応するページが含まれます。

- ## 概要

  概要ページはAPIドキュメントのフロント・ページで、各パッケージのサマリーを含む全パッケージのリストが表示されます。一連のパッケージの全体的な説明も表示されます。

- ## パッケージ

  各パッケージには、そのパッケージのクラスおよびインタフェースのリストと、それぞれのサマリーを含むページがあります。このページは6つのカテゴリで構成されます。

  - インタフェース(イタリック)
  - クラス
  - 列挙型
  - 例外
  - エラー
  - 注釈型

- ## クラスまたはインタフェース

  各クラス、インタフェース、ネストされたクラスおよびネストされたインタフェースには個別のページがあります。各ページには次のように、クラスまたはインタフェースの説明と、サマリー表およびメンバーの詳細説明が含まれます。

  - クラス階層表示
  - 直系のサブクラス
  - 既知のサブインタフェースのリスト
  - 既知の実装クラスのリスト
  - クラスまたはインタフェースの宣言
  - クラスまたはインタフェースの説明
  - ネストされたクラスのサマリー
  - フィールドのサマリー
  - コンストラクタのサマリー
  - メソッドのサマリー
  - フィールドの詳細
  - コンストラクタの詳細
  - メソッドの詳細

  各サマリー・エントリには、その項目の詳細説明の中から1行目の文が表示されます。サマリー・エントリはアルファベット順ですが、詳細説明はソース・コードに現れる順になっています。これによって、プログラマが設定した論理的なグループ分けが保持されます。

- ## 注釈型

  各注釈型には、それ自身の個別のページと次のセクションがあります:

  - 注釈型の宣言
  - 注釈型の説明
  - 必須要素のサマリー
  - 任意要素のサマリー
  - 要素の詳細

- ## 列挙型

  各列挙型には、それ自身の個別のページと次のセクションがあります:

  - 列挙型の宣言
  - 列挙型の説明
  - 列挙型定数のサマリー
  - 列挙型定数の詳細

- ## 使用

  各ドキュメント化されたパッケージ、クラスおよびインタフェースにはそれぞれ「使用」ページがあります。このページには、どのようなパッケージ、クラス、メソッド、コンストラクタおよびフィールドが、特定のクラスまたはパッケージの一部を使用しているかが記述されています。たとえば、クラスAまたはインタフェースAの場合、その「使用」ページには、Aのサブクラス、Aとして宣言されるフィールド、Aを返すメソッドと、型Aを持つメソッドおよびコンストラクタが含まれます。このページにアクセスするには、まずそのパッケージ、クラスまたはインタフェースに移動し、ナビゲーション・バーの「使用」リンクをクリックしてください。

- ## 階層ツリー(クラス階層)

  すべてのパッケージにはクラス階層ページがあり、さらに各パッケージの階層があります。各階層ページは、クラスのリストとインタフェースのリストを含みます。クラスは`java.lang.Object`を開始点とする継承構造で編成されます。インタフェースは、`java.lang.Object`からは継承しません。

  - 概要ページを表示しているときに「階層ツリー」をクリックすると、全パッケージの階層が表示されます。
  - 特定のパッケージ、クラスまたはインタフェースを表示しているときに「階層ツリー」をクリックすると、該当するパッケージのみの階層が表示されます。

- ## 非推奨のAPI

  非推奨のAPIページは、非推奨のAPIをすべてリストします。非推奨のAPIとは、機能改良などの理由から使用をお薦めできなくなったAPIのことで、通常はそれに代わるAPIが提供されます。非推奨のAPIは今後の実装で削除される可能性があります。

- ## 索引

  索引には、すべてのクラス、インタフェース、コンストラクタ、メソッドおよびフィールドのアルファベット順のリストが含まれます。

- ## 前/次

  これらのリンクにより、前または次のクラス、インタフェース、パッケージまたは関連ページへ移動できます。

- ## フレーム/フレームなし

  これらのリンクはHTMLフレームの表示と非表示を切り替えます。すべてのページはフレームありでも、フレームなしでも表示できます。

- ## すべてのクラス

  すべてのクラスリンクには、すべてのクラスおよびインタフェース(非staticのネストされた型を除く)が表示されます。

- ## 直列化された形式

  直列化可能または外部化可能な各クラスは、直列化フィールドとメソッドの説明を含みます。この情報は、APIを使用する開発者ではなく、再実装を行う担当者に役立ちます。ナビゲーション・バーにリンクがない場合、直列化されたクラスに移動して、クラス記述の「関連項目」セクションにある「直列化された形式」をクリックすることにより、この情報を表示できます。

- ## 定数フィールド値

  定数フィールド値ページには、static finalフィールドとその値のリストがあります。

このヘルプ・ファイルは、標準docletを使用して生成されたAPIドキュメントに適用されます。

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.