Javadocのサンプル
WEB+DB PRESS Vol.51

com.javareading.taglet
クラス RequireTaglet

java.lang.Object
  上位を拡張 com.javareading.taglet.RequireTaglet
すべての実装されたインタフェース:
com.sun.tools.doclets.Taglet

public class RequireTaglet
extends Object
implements com.sun.tools.doclets.Taglet

事前条件を説明するタグレットクラス


コンストラクタの概要
RequireTaglet()
           
 
メソッドの概要
 String getName()
          このカスタムタグの名前を返します。
 boolean inConstructor()
          このタグレットがコンストラクタドキュメンテーションで使用されている場合、true を返します。
 boolean inField()
          このタグレットがフィールドドキュメンテーションで使用されている場合、true を返します。
 boolean inMethod()
          このタグレットがメソッドキュメンテーションで使用されている場合、true を返します。
 boolean inOverview()
          このタグレットが概要ドキュメンテーションで使用されている場合、true を返します。
 boolean inPackage()
          このタグレットがパッケージドキュメンテーションで使用されている場合、true を返します。
 boolean inType()
          このタグレットがタイプドキュメンテーション (クラスまたはインタフェース) で使用されている場合、true を返します。
 boolean isInlineTag()
          このタグレットがインラインタグである場合は true、そうでない場合は false を返します。
static void register(Map map)
          タグレットを登録します。
 String toString(com.sun.javadoc.Tag tag)
          このカスタムタグのタグ表現を受け取り、文字列としての表現を返し、生成されたページに出力します。
 String toString(com.sun.javadoc.Tag[] tags)
          このカスタムタグのタグ表現の配列を受け取り、文字列としての表現を返し、生成されたページに出力します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

RequireTaglet

public RequireTaglet()
メソッドの詳細

register

public static void register(Map map)
タグレットを登録します。

パラメータ:
map - タグのインスタンスを格納したMapオブジェクト

getName

public String getName()
このカスタムタグの名前を返します。 "@" + このメソッドの戻り値の値がタグの名前となります。

例) @require text != null

定義:
インタフェース com.sun.tools.doclets.Taglet 内の getName
戻り値:
タグレットの名前

inField

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

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inField
戻り値:
常にfalse

inConstructor

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

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inConstructor
戻り値:
true

inMethod

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

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inMethod
戻り値:
常にtrue

inOverview

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

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inOverview
戻り値:
常にfalse

inPackage

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

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inPackage
戻り値:
常にfalse

inType

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

定義:
インタフェース com.sun.tools.doclets.Taglet 内の inType
戻り値:
常にfalse

isInlineTag

public boolean isInlineTag()
このタグレットがインラインタグである場合は true、そうでない場合は false を返します。

定義:
インタフェース com.sun.tools.doclets.Taglet 内の isInlineTag
戻り値:
常にfalse

toString

public String toString(com.sun.javadoc.Tag tag)
このカスタムタグのタグ表現を受け取り、文字列としての表現を返し、生成されたページに出力します。

定義:
インタフェース com.sun.tools.doclets.Taglet 内の toString
パラメータ:
tag - このカスタムタグのタグ表現
戻り値:
このタグの文字列としての表現

toString

public String toString(com.sun.javadoc.Tag[] tags)
このカスタムタグのタグ表現の配列を受け取り、文字列としての表現を返し、生成されたページに出力します。

定義:
インタフェース com.sun.tools.doclets.Taglet 内の toString
パラメータ:
tags - このカスタムタグを表すタグの配列
戻り値:
このタグの文字列としての表現

WEB+DB PRESS Vol.51

Copyright 2009 技術評論社