クラス DocletVerCheck
- java.lang.Object
-
- org.opengion.fukurou.taglet.DocletVerCheck
-
public final class DocletVerCheck extends java.lang.Object
ソースコメントから、タグ情報を取り出す Doclet クラスです。 パラメータの version に一致する og.rev タグの 書かれたメソッドを、 ピックアップします。 og.rev タグ で、まとめて表示します。 ルールとしては、X.X.X.X だけが引数で渡されますので、 X.X.X.X (YYYY/MM/DD) が コメントとして記載されているとして、処理します。 そして、それ以降の記述の、「。」までを、キーワードとして、まとめます。 キーワード以下は、それぞれのコメントとして、各メソッドの直前に表示します。 このクラスは、RELEASE-NOTES.txt を作成する場合に、変更箇所をピックアップするのに使用します。- 導入されたバージョン:
- JDK5.0,
-
-
メソッドの概要
すべてのメソッド staticメソッド concreteメソッド 修飾子とタイプ メソッド 説明 static int
optionLength(java.lang.String option)
カスタムオプションを使用するドックレットの必須メソッド optionLength(String) です。static boolean
start(com.sun.javadoc.RootDoc root)
Doclet のエントリポイントメソッドです。
-
-
-
メソッドの詳細
-
start
public static boolean start(com.sun.javadoc.RootDoc root)
Doclet のエントリポイントメソッドです。- パラメータ:
root
- エントリポイントのRootDocオブジェクト- 戻り値:
- 正常実行時 true
-
optionLength
public static int optionLength(java.lang.String option)
カスタムオプションを使用するドックレットの必須メソッド optionLength(String) です。 ドックレットに認識させる各カスタムオプションに、 optionLength がその オプションを構成する要素 (トークン) の数を返さなければなりません。 このカスタムオプションでは、 -tag オプションそのものと その値の 2 つの要素で構成されるので、作成するドックレットの optionLengthメソッドは、 -tag オプションに対して 2 を返さなくては なりません。また、認識できないオプションに対しては、0 を返します。- パラメータ:
option
- オプション文字列- 戻り値:
- 要素(トークン) の数
-
-