6.1 APIの記述形式
HMP-PCTOがサポートするクラス・インタフェース、アノテーションおよび例外の記述形式について説明します。
各項で説明する項目は次のとおりです。
クラス・インタフェース
- 説明
-
クラス・インタフェースの機能について説明します。
- メソッド
-
クラス・インタフェースのメソッドの一覧について説明します。
なお、親クラスから継承したメソッドは記載していません。
- パッケージ名称
-
クラス・インタフェースのパッケージ名称について説明します。
アノテーション
- 説明
-
アノテーションの機能について説明します。
- 適用可能要素
-
アノテーションの適用可能要素について説明します。
- 属性
-
アノテーションの属性の一覧について説明します。
- パッケージ名称
-
クラス・インタフェースのパッケージ名称について説明します。
例外
- 説明
-
例外の機能について説明します。
- メソッド
-
例外のメソッドの一覧について説明します。
なお、親クラスから継承したメソッドは記載していません。
- パッケージ名称
-
例外のパッケージ名称について説明します。
- 継承関係
-
例外の継承関係について説明します。
メソッド
- 説明
-
メソッドの機能について説明します。
- 形式
-
メソッドの形式について説明します。
- 引数
-
メソッドの引数について説明します。
- 例外
-
メソッドを利用する際に発生する例外について説明します。
- 戻り値
-
メソッドの戻り値について説明します。