|
ドックレット API | ||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object com.sun.javadoc.Doclet
public abstract class Doclet
この例は、ドックレットの起動クラスの例として、エントリポイントメソッドを示しています。起動クラスは、パッケージの解説で説明されているように、com.sun.javadoc.* をインポートし、start(RootDoc)
メソッドを実装しなければなりません。ドックレットは、コマンド行オプションを取る場合、optionLength
と validOptions
も実装する必要があります。
1.1 以降追加された言語機能 (総称と注釈など) をサポートするドックレットは、languageVersion
を実装してこのことを示す必要があります。この実装を行わないと、ドックレットは 1.5 以降追加されたドックレット API メソッドを呼び出すことができなくなり、ドックレットから新しい構造要素 (型パラメータなど) を隠すためにほかの複数のメソッドの結果が変更されてしまいます。
ドックレットを起動するには、Javadoc ツールのコマンド行で -doclet
の直後に起動クラスの完全修飾名を続けて渡します。
コンストラクタの概要 | |
---|---|
Doclet()
|
メソッドの概要 | |
---|---|
static LanguageVersion |
languageVersion()
このドックレットがサポートしている Java プログラミング言語のバージョンを返します。 |
static int |
optionLength(String option)
ドックレット追加オプションをチェックします。 |
static boolean |
start(RootDoc root)
ドキュメントを生成します。 |
static boolean |
validOptions(String[][] options,
DocErrorReporter reporter)
オプションの引数が正しいかどうかをチェックします。 |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
コンストラクタの詳細 |
---|
public Doclet()
メソッドの詳細 |
---|
public static boolean start(RootDoc root)
public static int optionLength(String option)
ドックレットがオプションを含む場合、このメソッドが必要です。このメソッドがないと、Javadoc は、すべてのオプションで無効なフラグエラーを出力します。
public static boolean validOptions(String[][] options, DocErrorReporter reporter)
このメソッドの使用は必須ではありませんが、推奨されています。このメソッドがない場合は、すべてのオプションが有効とみなされます。使用しない場合は、デフォルト値 (true) が返されます。
表示オプション関連のエラーメッセージ (提供されている DocErrorReporter を使用) は、このメソッドの責任です。
public static LanguageVersion languageVersion()
このメソッドは、1.1 以降の言語バージョンをサポートしているドックレットで必要です。
|
ドックレット API | ||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |