Interface SeeTag
- All Superinterfaces:
Tag
@Deprecated(since="9",
forRemoval=true)
public interface SeeTag
extends Tag jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.Represents a user-defined cross-reference to related documentation. The tag can reference a package, class or member, or can hold plain text. (The plain text might be a reference to something not online, such as a printed book, or be a hard-coded HTML link.) The reference can either be inline with the comment, using {@link}, or a separate block comment, using @see. Method name() returns "@link" (no curly braces) or "@see", depending on the tag. Method kind() returns "@see" for both tags.
Methods
| Modifier and Type | Method | Description |
|---|---|---|
String | label() | Deprecated, for removal: This API element is subject to removal in a future version. Get the label of the |
ClassDoc | referencedClass() | Deprecated, for removal: This API element is subject to removal in a future version. Get the class doc referenced by the class name part of @see. |
String | referencedClassName() | Deprecated, for removal: This API element is subject to removal in a future version. Get the class or interface name of the |
MemberDoc | referencedMember() | Deprecated, for removal: This API element is subject to removal in a future version. Get the member doc for the field, constructor or method referenced by |
String | referencedMemberName() | Deprecated, for removal: This API element is subject to removal in a future version. Get the field, constructor or method substring of the |
PackageDoc | referencedPackage() | Deprecated, for removal: This API element is subject to removal in a future version. Get the package doc when |
Methods declared in interface com.sun.javadoc.Tag
firstSentenceTags, holder, inlineTags, kind, name, position, text, toString Methods
label
String label()
Get the label of the @see tag. Return null if no label is present. For example, for:
@see String#trim() the trim method
- Returns:
- "the trim method".
referencedPackage
PackageDoc referencedPackage()
Get the package doc when @see references only a package. Return null if the package cannot be found, or if @see references any other element (class, interface, field, constructor, method) or non-element. For example, for:
@see java.lang
PackageDoc for java.lang.- Returns:
- the
PackageDocforjava.lang.
referencedClassName
String referencedClassName()
Get the class or interface name of the @see reference. The name is fully qualified if the name specified in the original @see tag was fully qualified, or if the class or interface can be found; otherwise it is unqualified. If @see references only a package name, then return the package name instead. For example, for:
@see String#valueOf(java.lang.Object)
@see java.lang", return "java.lang". Return null if @see references a non-element, such as @see <a href="java.sun.com">.- Returns:
- null if
@seereferences a non-element, such as@see <a href="java.sun.com">.
referencedClass
ClassDoc referencedClass()
Get the class doc referenced by the class name part of @see. Return null if the class cannot be found. For example, for:
@see String#valueOf(java.lang.Object)
ClassDoc for java.lang.String.- Returns:
- the
ClassDocforjava.lang.String.
referencedMemberName
String referencedMemberName()
Get the field, constructor or method substring of the @see reference. Return null if the reference is to any other element or to any non-element. References to member classes (nested classes) return null. For example, for:
@see String#startsWith(String)
- Returns:
- "startsWith(String)".
referencedMember
MemberDoc referencedMember()
Get the member doc for the field, constructor or method referenced by @see. Return null if the member cannot be found or if the reference is to any other element or to any non-element. References to member classes (nested classes) return null. For example, for:
@see String#startsWith(java.lang.String)
MethodDoc for startsWith.- Returns:
- the
MethodDocforstartsWith.
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/jdk.javadoc/com/sun/javadoc/SeeTag.html