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

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

    java.lang.Object
      org.opengion.fukurou.taglet.AbstractTaglet
          org.opengion.fukurou.taglet.TagletFormSample

すべての実装されたインタフェース:
  com.sun.tools.doclets.Taglet

    public class TagletFormSample

extends AbstractTaglet

ソースコメントから、Javadoc を作成する場合のカスタムタグ情報を作成する Taglet インターフェースの実装クラスを作成します。 og.formSample タグ(形式サンプル)を処理します。

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

コンストラクタの概要
`TagletFormSample()`

メソッドの概要
`java.lang.String` | `getName()` このカスタムタグの名前を返します。
`static void` | `register(java.util.Map<java.lang.String,com.sun.tools.doclets.Taglet> tagletMap)` 実行時にドックレットがタグレットを読み込んで使用するには、 そのタグレットが、次のシグニチャでマップ を引数として受け取る、 レジスタ と呼ばれる static メソッドをもっている必要があります。
`java.lang.String` | `toString(com.sun.javadoc.Tag tagTag)` このカスタムタグのタグ表現を受け取り、 文字列としての表現を返し、生成されたページに出力します。
`java.lang.String` | `toString(com.sun.javadoc.Tag[] tagTags)` このカスタムタグのタグ表現の配列を受け取り、 文字列としての表現を返し、生成されたページに出力します。

クラス org.opengion.fukurou.taglet.AbstractTaglet から継承されたメソッド
`inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag, link`

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

コンストラクタの詳細

### TagletFormSample

    public TagletFormSample()

メソッドの詳細

### register

    public static void register(java.util.Map<java.lang.String,com.sun.tools.doclets.Taglet> tagletMap)

  実行時にドックレットがタグレットを読み込んで使用するには、 そのタグレットが、次のシグニチャでマップ を引数として受け取る、 レジスタ と呼ばれる static メソッドをもっている必要があります。 このメソッドは、タグレット名をキーとして、カスタムタグレットの インスタンスをマップに追加します。 タグレットをオーバーライドする場合、 名前の競合を避けるため、新しいタグレットのインスタンスをマップに 追加する前に、オーバーライドされる側のタグレットをマップから 削除する必要があります。

  パラメータ:
    `tagletMap` - Map

### getName

    public java.lang.String getName()

  このカスタムタグの名前を返します。

  戻り値:
    カスタムタグの名前

### toString

    public java.lang.String toString(com.sun.javadoc.Tag tagTag)

  このカスタムタグのタグ表現を受け取り、 文字列としての表現を返し、生成されたページに出力します。

  パラメータ:
    `tagTag` - このカスタムタグのタグ表現
  戻り値:
    このタグの文字列としての表現

### toString

    public java.lang.String toString(com.sun.javadoc.Tag[] tagTags)

  このカスタムタグのタグ表現の配列を受け取り、 文字列としての表現を返し、生成されたページに出力します。 このタグレットがインラインタグを表す場合、 このメソッドは null を返します。

  パラメータ:
    `tagTags` - Tag[] このカスタムタグを表すタグの配列
  戻り値:
    このタグの文字列としての表現
  変更履歴:

    5.1.9.0 (2010/08/01) dtタグをきちんと記述する。

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

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