Overview | Package | Class | Tree | Deprecated | Index | Help | |||
PREV CLASS | NEXT CLASS | FRAMES | NO FRAMES | ||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Fields inherited from class java.io.Serializable | |
serialVersionUID |
Method Summary | |
java.lang.String | commentText()
Return the text of the comment for this doc item. |
int | compareTo(java.lang.Object obj)
Compares this Object with the specified Object for order. |
Tag[] | firstSentenceTags()
|
java.lang.String | getRawCommentText()
Return the full unprocessed text of the comment. |
Tag[] | inlineTags()
|
boolean | isClass()
Is this Doc item a class. |
boolean | isConstructor()
Is this Doc item a constructor? |
boolean | isError()
Is this Doc item a error class? |
boolean | isException()
Is this Doc item a exception class? |
boolean | isField()
Is this Doc item a field? |
boolean | isIncluded()
return true if this Doc is include in the active set. |
boolean | isInterface()
Is this Doc item a interface? |
boolean | isMethod()
Is this Doc item a simple method (i.e. not a constructor)? |
boolean | isOrdinaryClass()
Is this Doc item a ordinary class (i.e. not an interface, exception, or error)? |
java.lang.String | name()
Returns the name of this Doc item. |
SeeTag[] | seeTags()
Return the see also tags in this Doc item. |
void | setRawCommentText(java.lang.String rawDocumentation)
Set the full unprocessed text of the comment. |
Tag[] | tags()
Return all tags in this Doc item. |
Tag[] | tags(java.lang.String tagname)
Return tags of the specified kind in this Doc item. |
Method Detail |
public java.lang.String commentText()
public Tag[] tags()
public Tag[] tags(java.lang.String tagname)
tagname
- name of the tag kind to search for.public SeeTag[] seeTags()
public Tag[] inlineTags()
public Tag[] firstSentenceTags()
public java.lang.String getRawCommentText()
public void setRawCommentText(java.lang.String rawDocumentation)
public java.lang.String name()
public int compareTo(java.lang.Object obj)
Included so that Doc item are java.lang.Comparable.
o
- the Object
to be compared.public boolean isField()
public boolean isMethod()
public boolean isConstructor()
public boolean isInterface()
public boolean isException()
public boolean isError()
public boolean isOrdinaryClass()
public boolean isClass()
public boolean isIncluded()
Overview | Package | Class | Tree | Deprecated | Index | Help | |||
PREV CLASS | NEXT CLASS | FRAMES | NO FRAMES | ||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |