概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.0.1.1
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.opengion.fukurou.taglet
クラス DocletParam

    java.lang.Object
      org.opengion.fukurou.taglet.DocletParam

    public final class DocletParam

extends java.lang.Object

ソースコメントから、パラメータ情報を取り出す Doclet クラスです。 og.paramLevel タグと og.cryptography タグを切り出します。 これらは、ｼｽﾃﾑパラメータとしてGE12ﾃｰﾌﾞﾙに設定される値をクラスより抽出する のに使用します。

バージョン
  4.0
作成者
  Kazuhiko Hasegawa
導入されたバージョン:
  JDK5.0,

メソッドの概要
`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` - RootDoc
  戻り値:
    正常実行時 true

### optionLength

    public static int optionLength(java.lang.String option)

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

  パラメータ:
    `option` - String
  戻り値:
    要素 (トークン) の数

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| openGion 5.0.1.1
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.