• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/javadoc/SeeTag.java@2eb010b6cb22 (annotated)

src/share/classes/com/sun/javadoc/SeeTag.java

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 554

9d9f26857129

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1998, 2002, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.javadoc;
aoqi@0	27
aoqi@0	28	/**
aoqi@0	29	* Represents a user-defined cross-reference to related documentation.
aoqi@0	30	* The tag can reference a package, class or member, or can hold
aoqi@0	31	* plain text. (The plain text might be a reference
aoqi@0	32	* to something not online, such as a printed book, or be a hard-coded
aoqi@0	33	* HTML link.) The reference can either be inline with the comment,
aoqi@0	34	* using <code>&#123;@link}</code>, or a separate block comment,
aoqi@0	35	* using <code>@see</code>.
aoqi@0	36	* Method <code>name()</code> returns "@link" (no curly braces) or
aoqi@0	37	* "@see", depending on the tag.
aoqi@0	38	* Method <code>kind()</code> returns "@see" for both tags.
aoqi@0	39	*
aoqi@0	40	* @author Kaiyang Liu (original)
aoqi@0	41	* @author Robert Field (rewrite)
aoqi@0	42	* @author Atul M Dambalkar
aoqi@0	43	*
aoqi@0	44	*/
aoqi@0	45	public interface SeeTag extends Tag {
aoqi@0	46
aoqi@0	47	/**
aoqi@0	48	* Get the label of the <code>@see</code> tag.
aoqi@0	49	* Return null if no label is present.
aoqi@0	50	* For example, for:
aoqi@0	51	* <p>
aoqi@0	52	* &nbsp;&nbsp;<code>@see String#trim() the trim method</code>
aoqi@0	53	* </p>
aoqi@0	54	* return "the trim method".
aoqi@0	55	*/
aoqi@0	56	String label();
aoqi@0	57
aoqi@0	58	/**
aoqi@0	59	* Get the package doc when <code>@see</code> references only a package.
aoqi@0	60	* Return null if the package cannot be found, or if
aoqi@0	61	* <code>@see</code> references any other element (class,
aoqi@0	62	* interface, field, constructor, method) or non-element.
aoqi@0	63	* For example, for:
aoqi@0	64	* <p>
aoqi@0	65	* &nbsp;&nbsp;<code>@see java.lang</code>
aoqi@0	66	* </p>
aoqi@0	67	* return the <code>PackageDoc</code> for <code>java.lang</code>.
aoqi@0	68	*/
aoqi@0	69	public PackageDoc referencedPackage();
aoqi@0	70
aoqi@0	71	/**
aoqi@0	72	* Get the class or interface name of the <code>@see</code> reference.
aoqi@0	73	* The name is fully qualified if the name specified in the
aoqi@0	74	* original <code>@see</code> tag was fully qualified, or if the class
aoqi@0	75	* or interface can be found; otherwise it is unqualified.
aoqi@0	76	* If <code>@see</code> references only a package name, then return
aoqi@0	77	* the package name instead.
aoqi@0	78	* For example, for:
aoqi@0	79	* <p>
aoqi@0	80	* &nbsp;&nbsp;<code>@see String#valueOf(java.lang.Object)</code>
aoqi@0	81	* </p>
aoqi@0	82	* return "java.lang.String".
aoqi@0	83	* For "<code>@see java.lang</code>", return "java.lang".
aoqi@0	84	* Return null if <code>@see</code> references a non-element, such as
aoqi@0	85	* <code>@see &lt;a href="java.sun.com"&gt;</code>.
aoqi@0	86	*/
aoqi@0	87	String referencedClassName();
aoqi@0	88
aoqi@0	89	/**
aoqi@0	90	* Get the class doc referenced by the class name part of @see.
aoqi@0	91	* Return null if the class cannot be found.
aoqi@0	92	* For example, for:
aoqi@0	93	* <p>
aoqi@0	94	* &nbsp;&nbsp;<code>@see String#valueOf(java.lang.Object)</code>
aoqi@0	95	* </p>
aoqi@0	96	* return the <code>ClassDoc</code> for <code>java.lang.String</code>.
aoqi@0	97	*/
aoqi@0	98	ClassDoc referencedClass();
aoqi@0	99
aoqi@0	100	/**
aoqi@0	101	* Get the field, constructor or method substring of the <code>@see</code>
aoqi@0	102	* reference. Return null if the reference is to any other
aoqi@0	103	* element or to any non-element.
aoqi@0	104	* References to member classes (nested classes) return null.
aoqi@0	105	* For example, for:
aoqi@0	106	* <p>
aoqi@0	107	* &nbsp;&nbsp;<code>@see String#startsWith(String)</code>
aoqi@0	108	* </p>
aoqi@0	109	* return "startsWith(String)".
aoqi@0	110	*/
aoqi@0	111	String referencedMemberName();
aoqi@0	112
aoqi@0	113	/**
aoqi@0	114	* Get the member doc for the field, constructor or method
aoqi@0	115	* referenced by <code>@see</code>. Return null if the member cannot
aoqi@0	116	* be found or if the reference is to any other element or to any
aoqi@0	117	* non-element.
aoqi@0	118	* References to member classes (nested classes) return null.
aoqi@0	119	* For example, for:
aoqi@0	120	* <p>
aoqi@0	121	* &nbsp;&nbsp;<code>@see String#startsWith(java.lang.String)</code>
aoqi@0	122	* </p>
aoqi@0	123	* return the <code>MethodDoc</code> for <code>startsWith</code>.
aoqi@0	124	*/
aoqi@0	125	MemberDoc referencedMember();
aoqi@0	126	}