openGionopenGion
5.4.2.0

org.opengion.fukurou.taglet
クラス AbstractTaglet

java.lang.Object
  上位を拡張 org.opengion.fukurou.taglet.AbstractTaglet
すべての実装されたインタフェース:
com.sun.tools.doclets.Taglet
直系の既知のサブクラス:
TagletFormSample, TagletRev, TagletTag

public abstract class AbstractTaglet
extends java.lang.Object
implements com.sun.tools.doclets.Taglet

ソースコメントから、Javadoc を作成する場合のカスタムタグ情報を作成する Taglet インターフェースのAbstract 実装クラスを作成します。 デフォルトの タグレットとしての初期値を設定します。 つまり、isInlineTag() のみ false を返すメソッドを定義してあります。

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

コンストラクタの概要
AbstractTaglet()
           
 
メソッドの概要
 boolean inConstructor()
          このタグレットがコンストラクタドキュメンテーションで 使用されている場合、true を返します。
 boolean inField()
          このタグレットがフィールドドキュメンテーションで 使用されている場合、true を返します。
 boolean inMethod()
          このタグレットがメソッドドキュメンテーションで 使用されている場合、true を返します。
 boolean inOverview()
          このタグレットが概要ドキュメンテーションで 使用されている場合、true を返します。
 boolean inPackage()
          このタグレットがパッケージドキュメンテーションで 使用されている場合、true を返します。
 boolean inType()
          このタグレットがタイプドキュメンテーションで 使用されている場合、true を返します。
 boolean isInlineTag()
          このタグレットがインラインタグで 使用されている場合、true を返します。
protected  java.lang.String link(java.lang.String in)
          このタグレットがインラインタグで {@link XXXX YYYY} を処理するように 用意された、カスタムメソッドです。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース com.sun.tools.doclets.Taglet から継承されたメソッド
getName, toString, toString
 

コンストラクタの詳細

AbstractTaglet

public AbstractTaglet()
メソッドの詳細

inField

public boolean inField()
このタグレットがフィールドドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inField
戻り値:
フィールドドキュメンテーションの場合は true、そうでない場合は false を返します

inConstructor

public boolean inConstructor()
このタグレットがコンストラクタドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inConstructor
戻り値:
コンストラクタドキュメンテーションの場合は true、そうでない場合は false を返します

inMethod

public boolean inMethod()
このタグレットがメソッドドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inMethod
戻り値:
メソッドドキュメンテーションの場合は true、そうでない場合は false を返します

inOverview

public boolean inOverview()
このタグレットが概要ドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inOverview
戻り値:
概要ドキュメンテーションの場合は true、そうでない場合は false を返します

inPackage

public boolean inPackage()
このタグレットがパッケージドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inPackage
戻り値:
パッケージドキュメンテーションの場合は true、そうでない場合は false を返します

inType

public boolean inType()
このタグレットがタイプドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inType
戻り値:
タイプドキュメンテーションの場合は true、そうでない場合は false を返します

isInlineTag

public boolean isInlineTag()
このタグレットがインラインタグで 使用されている場合、true を返します。 そうでない場合については false が設定されます。

定義:
インタフェース com.sun.tools.doclets.Taglet 内の isInlineTag
戻り値:
インラインタグの場合は true、そうでない場合は false を返します

link

protected java.lang.String link(java.lang.String in)
このタグレットがインラインタグで {@link XXXX YYYY} を処理するように 用意された、カスタムメソッドです。

パラメータ:
in - String オリジナルの文字列
戻り値:
String インラインタグの link を処理した結果の文字列
変更履歴:
5.1.9.0 (2010/08/01) 新規追加

openGion 5.4.2.0

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