com.sun.javadoc
インタフェース SeeTag

すべてのスーパーインタフェース:
Tag

public interface SeeTag
extends Tag

ドキュメンテーションタグ @see を表します。@see タグは、プレーンテキストか、クラスまたはメンバの参照になります。


メソッドの概要
 String label()
          このメソッドは、see タグのラベルを返します。
 ClassDoc referencedClass()
          このメソッドは、@see のクラス名の部分によって参照されるクラスを取得します。
 String referencedClassName()
          このメソッドは、@see のクラス名の部分を取得します。
 MemberDoc referencedMember()
          このメソッドは、@see のプロトタイプ部分によって参照されるメンバを取得します。
 String referencedMemberName()
          このメソッドは、@see のプロトタイプ部分によって参照されるメンバの名前を取得します。
 PackageDoc referencedPackage()
          このメソッドは、@see で参照されるパッケージを取得します。
 
インタフェース com.sun.javadoc.Tag から継承したメソッド
firstSentenceTags, inlineTags, kind, name, position, text, toString
 

メソッドの詳細

label

public String label()
このメソッドは、see タグのラベルを返します。


referencedPackage

public PackageDoc referencedPackage()
このメソッドは、@see で参照されるパッケージを取得します。たとえば、コメントが @see java.lang の場合、この関数では java.lang に PackageDoc が返されます。既知のパッケージが存在しない場合は、null が返されます。


referencedClassName

public String referencedClassName()
このメソッドは、@see のクラス名の部分を取得します。たとえば、コメントが @see String#startsWith(java.lang.String) の場合は、String が返されます。形式が Java の参照形式と異なる場合は、null が返されます。クラス名が指定されていない場合は、空文字列が返されます。


referencedClass

public ClassDoc referencedClass()
このメソッドは、@see のクラス名の部分によって参照されるクラスを取得します。たとえば、コメントが @see String#startsWith(java.lang.String) の場合は、java.lang.String の ClassDoc が返されます。クラスが javadoc のコマンド行で指定されたクラスではない場合は、null を返します。


referencedMemberName

public String referencedMemberName()
このメソッドは、@see のプロトタイプ部分によって参照されるメンバの名前を取得します。たとえば、コメントが @see String#startsWith(java.lang.String) の場合は、startsWith(java.lang.String) が返されます。形式が Java の参照形式と異なる場合は、null が返されます。メンバ名が指定されていない場合は、空文字列が返されます。


referencedMember

public MemberDoc referencedMember()
このメソッドは、@see のプロトタイプ部分によって参照されるメンバを取得します。たとえば、コメントが @see String#startsWith(java.lang.String) の場合は、startsWith の MethodDoc が返されます。メンバを特定できなかった場合は、null が返されます。



バグや機能要求の報告
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.