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()`

  - ### メソッドのサマリー

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

    - ### クラスから継承されたメソッド org.opengion.fukurou.taglet.AbstractTaglet

      `inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag, text`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### TagletFormSample

          public TagletFormSample()

  - ### メソッドの詳細

    - #### register

          public static void register(Map tagletMap)

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

    - #### getName

          public String getName()

      このカスタムタグの名前を返します。
      戻り値:
        カスタムタグの名前

    - #### toString

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

      このカスタムタグのタグ表現を受け取り、 文字列としての表現を返し、生成されたページに出力します。
      パラメータ:
        `tagTag` - このカスタムタグのタグ表現
      戻り値:
        このタグの文字列としての表現
      変更履歴:

        6.0.2.0 (2014/09/19) インラインタグを処理できるように text(String) メソッド経由で出力する。

    - #### toString

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

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

        6.0.2.0 (2014/09/19) インラインタグを処理できるように text(String) メソッド経由で出力する。

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