com.sun.javadoc
クラス Doclet

java.lang.Object
  com.sun.javadoc.Doclet

public abstract class Doclet
extends Object

この例は、ドックレットの起動クラスの例として、エントリポイントメソッドを示しています。起動クラスは、パッケージの解説で説明されているように、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

コンストラクタの詳細

Doclet

public Doclet()

メソッドの詳細

start

public static boolean start(RootDoc root)

ドキュメントを生成します。このメソッドは、すべてのドックレットで必要です。

戻り値:

成功した場合は、true

optionLength

public static int optionLength(String option)

ドックレット追加オプションをチェックします。指定されたオプションのコマンド行で指定しなければならない引数の数を返します。たとえば、「-d docs」の場合は 2 が返されます。

ドックレットがオプションを含む場合、このメソッドが必要です。このメソッドがないと、Javadoc は、すべてのオプションで無効なフラグエラーを出力します。

戻り値:

オプションの名前自体を含むオプションのコマンド行での引数の数。未知のオプションの場合は、ゼロ。エラーが発生した場合は、負の値

validOptions

public static boolean validOptions(String[][] options,
                                   DocErrorReporter reporter)

オプションの引数が正しいかどうかをチェックします。

このメソッドの使用は必須ではありませんが、推奨されています。このメソッドがない場合は、すべてのオプションが有効とみなされます。使用しない場合は、デフォルト値 (true) が返されます。

表示オプション関連のエラーメッセージ (提供されている DocErrorReporter を使用) は、このメソッドの責任です。

戻り値:

オプションが有効な場合は、true

languageVersion

public static LanguageVersion languageVersion()

このドックレットがサポートしている Java プログラミング言語のバージョンを返します。

このメソッドは、1.1 以降の言語バージョンをサポートしているドックレットで必要です。

戻り値:

このドックレットがサポートしている言語バージョン

導入されたバージョン:

1.5