Subversion Repositories openrisc

/* SeeTag.java -- Information about "@see" tags.

   Copyright (C) 1999 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 2, or (at your option)

any later version.

GNU Classpath is distributed in the hope that it will be useful, but

WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

General Public License for more details.

You should have received a copy of the GNU General Public License

along with GNU Classpath; see the file COPYING.  If not, write to the

Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA

02110-1301 USA.

Linking this library statically or dynamically with other modules is

making a combined work based on this library.  Thus, the terms and

conditions of the GNU General Public License cover the whole

combination.

As a special exception, the copyright holders of this library give you

permission to link this library with independent modules to produce an

executable, regardless of the license terms of these independent

modules, and to copy and distribute the resulting executable under

terms of your choice, provided that you also meet, for each linked

independent module, the terms and conditions of the license of that

module.  An independent module is a module which is not derived from

or based on this library.  If you modify this library, you may extend

this exception to your version of the library, but you are not

obligated to do so.  If you do not wish to do so, delete this

exception statement from your version. */

package com.sun.javadoc;

/**

  * This interface models an "@see" tag.

  */

public interface SeeTag extends Tag

{

/**

  * This method returns the label for this tag.  What is this????

  *

  * @return The label for this tag.

  */

public abstract String

label();

/*************************************************************************/

/**

  * This method returns the package of the referenced item.

  *

  * @return The package of the referenced item, or <code>null</code> if no

  * package is found.

  */

public abstract PackageDoc

referencedPackage();

/*************************************************************************/

/**

  * This method returns the name of the class referenced in the tag.

  *

  * @return The name of the class referenced in the tag.

  */

public abstract String

referencedClassName();

/*************************************************************************/

/**

  * This method returns a <code>ClassDoc</code> instance for the class

  * referenced in the tag.

  *

  * @return A <code>ClassDoc</code> for the class referenced in the tag.

  */

public abstract ClassDoc

referencedClass();

/*************************************************************************/

/**

  * This method returns the name of the member referenced in the tag.

  *

  * @return The name of the member referenced in the tag.

  */

public abstract String

referencedMemberName();

/*************************************************************************/

/**

  * This method returns a <code>MemberDoc</code> instance for the member

  * referenced in the tag.

  *

  * @return A <code>MemberDoc</code> for the member referenced in the tag.

  */

public abstract MemberDoc

referencedMember();

} // interface SeeTag