|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface represents a Java comment. Java comments come in three styles: traditional (block), single-line, and documentation. See chapters 3.7 and 18 of the Java Language Specification for more information.
Field Summary | |
static int |
BLOCK
Traditional (block) comment type. |
static int |
DOC
Documentation comment type. |
static int |
LINE
Single-line comment type. |
static int |
NONE
Comment has no type. |
Method Summary | |
java.lang.String |
getCommentText()
Returns the entire text of the comment including enclosing comment symbols. |
java.lang.String |
getNormalText()
Only valid if the type of this comment is DOC . |
java.lang.String |
getSummaryText()
Returns the first sentence of a documentation comment. |
int |
getType()
Returns the type of this comment. |
Methods inherited from interface com.borland.jbuilder.jot.JotMarker |
addUserData, getEndPosition, getStartPosition, getUserData |
Methods inherited from interface com.borland.jbuilder.jot.JotSourceElement |
getIndentLevel, getParent, getText, isModified, setModified, setText |
Field Detail |
public static final int NONE
public static final int BLOCK
public static final int LINE
public static final int DOC
Method Detail |
public int getType()
NONE
,
BLOCK
, LINE
, and DOC
.public java.lang.String getCommentText()
public java.lang.String getSummaryText()
public java.lang.String getNormalText()
DOC
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |