public abstract class Doclet extends Object
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)
オプションの引数が正しいかどうかをチェックします。
|
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 以降の言語バージョンをサポートしているドックレットで必要です。
バグまたは機能を送信
Java は米国ならびにその他の国における Oracle Corporation およびその関連企業の商標または登録商標です。
Copyright © 1993, 2013, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.