com.sun.javadoc
クラス Doclet

java.lang.Object
  |
  +--com.sun.javadoc.Doclet

public abstract class Doclet
extends Object

このクラスは、ドックレットに含まれるエントリポイントメソッドのドキュメントを生成します。このクラスをドックレットのスーパークラスとして使用することもできますが、そうする必要があるわけではありません。


コンストラクタの概要
Doclet()
           
 
メソッドの概要
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)
ドックレットに追加されたオプションをチェックします。

このメソッドは必ずしも使用する必要はありません。使用しない場合は、デフォルト値 (ゼロ) が返されます。

戻り値:
オプションの引数の数。未知のオプションの場合は、ゼロ。エラーが発生した場合は、負の値

validOptions

public static boolean validOptions(String[][] options,
                                   DocErrorReporter reporter)
オプションの引数が正しいかどうかをチェックします。

このメソッドは必ずしも使用する必要はありません。使用しない場合は、デフォルト値 (true) が返されます。

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

戻り値:
オプションが有効な場合は、true


バグや機能要求の報告
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.