クラス DocletVerCheck


  • public final class DocletVerCheck
    extends Object
    ソースコメントから、タグ情報を取り出す Doclet クラスです。 パラメータの version に一致する og.rev タグの 書かれたメソッドを、 ピックアップします。 og.rev タグ で、まとめて表示します。 ルールとしては、X.X.X.X だけが引数で渡されますので、 X.X.X.X (YYYY/MM/DD) が コメントとして記載されているとして、処理します。 そして、それ以降の記述の、「。」までを、キーワードとして、まとめます。 キーワード以下は、それぞれのコメントとして、各メソッドの直前に表示します。 このクラスは、RELEASE-NOTES.txt を作成する場合に、変更箇所をピックアップするのに使用します。
    バージョン
    6.0.2.3 (2014/10/10)
    作成者
    Kazuhiko Hasegawa
    導入されたバージョン:
    JDK5.0,
    • メソッドの詳細

      • start

        public static boolean start​(com.sun.javadoc.RootDoc root)
        Doclet のエントリポイントメソッドです。
        パラメータ:
        root - エントリポイントのRootDocオブジェクト
        戻り値:
        正常実行時 true
        変更履歴:
        6.0.2.3 (2014/10/10) 新規作成, 6.8.2.2 (2017/11/02) パッケージ名の簡略化を、汎用的に対応させます。
      • optionLength

        public static int optionLength​(String option)
        カスタムオプションを使用するドックレットの必須メソッド optionLength(String) です。 ドックレットに認識させる各カスタムオプションに、 optionLength がその オプションを構成する要素 (トークン) の数を返さなければなりません。 このカスタムオプションでは、 -tag オプションそのものと その値の 2 つの要素で構成されるので、作成するドックレットの optionLengthメソッドは、 -tag オプションに対して 2 を返さなくては なりません。また、認識できないオプションに対しては、0 を返します。
        パラメータ:
        option - オプション文字列
        戻り値:
        要素(トークン) の数
        変更履歴:
        6.8.2.2 (2017/11/02) パッケージ名の簡略化を、汎用的に対応させます。