com.borland.jbuilder.jot
Interface JotDocTag

All Superinterfaces:
JotMarker

public interface JotDocTag
extends JotMarker

This interface represents a JavaDoc tagged paragraph. A tagged paragraph is a line in a documentation comment which begins with a '@' and is followed by a keyword. For more information see section 18.4 in the Java Language Specification.


Field Summary
static int AUTHOR
           
static int DEPRECATED
          Deprecated. doc tag type.
static int EXCEPTION
           
static int PARAM
           
static int RETURN
           
static int SEE
           
static int UNKNOWN
          unknown doc tag type.
static int VERSION
           
 
Method Summary
 java.lang.String getParam1()
          Returns the first parameter of the document tag.
 java.lang.String getParam2()
          Returns the second parameter of the document tag.
 int getType()
          Returns the type of this document tag.
 void setParam1(java.lang.String text)
          Sets the first parameter of the document tag.
 void setParam2(java.lang.String text)
          Sets the second parameter of the document tag.
 
Methods inherited from interface com.borland.jbuilder.jot.JotMarker
addUserData, getEndPosition, getStartPosition, getUserData
 

Field Detail

SEE

public static final int SEE
See Also:
tag type.

VERSION

public static final int VERSION

AUTHOR

public static final int AUTHOR

RETURN

public static final int RETURN

PARAM

public static final int PARAM

EXCEPTION

public static final int EXCEPTION

DEPRECATED

public static final int DEPRECATED
Deprecated. doc tag type.


UNKNOWN

public static final int UNKNOWN
unknown doc tag type.
Method Detail

getType

public int getType()
Returns the type of this document tag.
See Also:
SEE, VERSION, AUTHOR, RETURN, PARAM, EXCEPTION, DEPRECATED, UNKNOWN

getParam1

public java.lang.String getParam1()
Returns the first parameter of the document tag. For example, name is the first parameter in the following document tag:
Parameters:
name - the name of the parameter

setParam1

public void setParam1(java.lang.String text)
Sets the first parameter of the document tag. For example, name is the first parameter in the following document tag:
Parameters:
name - the name of the parameter

getParam2

public java.lang.String getParam2()
Returns the second parameter of the document tag. For example, the description following name is the second parameter in the following document tag:
Parameters:
name - the name of the parameter

setParam2

public void setParam2(java.lang.String text)
Sets the second parameter of the document tag. For example, the description following name is the second parameter in the following document tag:
Parameters:
name - the name of the parameter