public interface Taglet
ドックレットが使用するカスタムタグのインタフェースです。カスタムタグはこのインタフェースを実装する必要があります。実行時にドックレットがタグレットを読み込んで使用するには、そのタグレットが、次のシグネチャで Map
を引数として受け取る、register
という static メソッドをもっている必要があります。
public void register(Map map)このメソッドは、タグレット名をキーとして、カスタムタグレットのインスタンスをマップに追加します。タグレットをオーバーライドする場合、名前の競合を避けるため、新しいタグレットのインスタンスをマップに追加する前に、オーバーライドされる側のタグレットをマップから削除する必要があります。
タグレットがそれ自体の登録に失敗した場合は、例外をスローすることをお勧めします。スローする例外はユーザ任意です。
2 つのタグレットの例を次に示します。
独自のタグレットの作成方法ついては、「タグレットの概要」を参照してください。
この API の拡張版を、ドックレットツールキットから入手できます。
com.sun.tools.doclets.internal.toolkit.taglets.Taglet
.
メソッドの概要 | |
---|---|
String |
getName()
このカスタムタグの名前を返します。 |
boolean |
inConstructor()
このタグレットがコンストラクタドキュメンテーションで使用されている場合、true を返します。 |
boolean |
inField()
このタグレットがフィールドドキュメンテーションで使用されている場合、true を返します。 |
boolean |
inMethod()
このタグレットがメソッドドキュメンテーションで使用されている場合、true を返します。 |
boolean |
inOverview()
このタグレットが概要ドキュメンテーションで使用されている場合、true を返します。 |
boolean |
inPackage()
このタグレットがパッケージドキュメンテーションで使用されている場合、true を返します。 |
boolean |
inType()
このタグレットが型ドキュメンテーション (クラスまたはインタフェース) で使用されている場合、true を返します。 |
boolean |
isInlineTag()
このタグレットがインラインタグで使用されている場合、true を返します。 |
String |
toString(com.sun.javadoc.Tag tag)
このカスタムタグの Tag 表現を受け取り、文字列としての表現を返します。その文字列は、生成されるページに出力されます。 |
String |
toString(com.sun.javadoc.Tag[] tags)
このカスタムタグの Tag 表現の配列を受け取り、文字列としての表現を返します。その文字列は、生成されるページに出力されます。 |
メソッドの詳細 |
---|
boolean inField()
boolean inConstructor()
boolean inMethod()
boolean inOverview()
boolean inPackage()
boolean inType()
boolean isInlineTag()
String getName()
String toString(com.sun.javadoc.Tag tag)
Tag
表現を受け取り、文字列としての表現を返します。その文字列は、生成されるページに出力されます。
tag
- このカスタムタグの Tag
表現
Tag
の文字列表現String toString(com.sun.javadoc.Tag[] tags)
Tag
表現の配列を受け取り、文字列としての表現を返します。その文字列は、生成されるページに出力されます。このタグレットがインラインタグを表す場合、このメソッドは null を返します。
tags
- このカスタムタグを表す Tag
の配列
Tag
の文字列表現