クラス DocletPlugin


  • public final class DocletPlugin
    extends java.lang.Object
    ソースコメントから、属性情報を取り出す Doclet クラスです。
    導入されたバージョン:
    JDK5.0,
    • メソッドの概要

      すべてのメソッド staticメソッド concreteメソッド 
      修飾子とタイプ メソッド 説明
      static int optionLength​(java.lang.String option)
      カスタムオプションを使用するドックレットの必須メソッド optionLength(String) です。
      static boolean start​(com.sun.javadoc.RootDoc root)
      Doclet のエントリポイントメソッドです。
      • クラスから継承されたメソッド java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • メソッドの詳細

      • start

        public static boolean start​(com.sun.javadoc.RootDoc root)
        Doclet のエントリポイントメソッドです。
        パラメータ:
        root - ドキュメントルートオブジェクト
        戻り値:
        正常実行時 true
      • optionLength

        public static int optionLength​(java.lang.String option)
        カスタムオプションを使用するドックレットの必須メソッド optionLength(String) です。 ドックレットに認識させる各カスタムオプションに、 optionLength がその オプションを構成する要素 (トークン) の数を返さなければなりません。 このカスタムオプションでは、 -tag オプションそのものと その値の 2 つの要素で構成されるので、作成するドックレットの optionLengthメソッドは、 -tag オプションに対して 2 を返さなくては なりません。また、認識できないオプションに対しては、0 を返します。
        パラメータ:
        option - オプション文字列
        戻り値:
        要素 (トークン) の数