クラス DocletTaglib


  • public final class DocletTaglib
    extends Object
    ソースコメントから、タグ情報を取り出す Doclet クラスです。 この Doclet は、":org.opengion.hayabusa.taglib" のみ対象として処理します。 og.formSample , og.tag , og.group タグを切り出します。
    バージョン
    4.0
    作成者
    Kazuhiko Hasegawa
    導入されたバージョン:
    JDK5.0,
    • メソッドの詳細

      • start

        public static boolean start​(com.sun.javadoc.RootDoc root)
        Doclet のエントリポイントメソッドです。
        パラメータ:
        root - エントリポイントのRootDocオブジェクト
        戻り値:
        正常実行時 true
        変更履歴:
        5.7.1.1 (2013/12/13) タグのインデントを止める。
      • optionLength

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