|
Doclet API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
abstract base class of all Doc classes. Doc item's are representations of java language constructs (class, package, method,...) which have comments and have been processed by this run of javadoc. All Doc items are unique, that is, they are == comparable.
Method Summary | |
String |
commentText()
Return the text of the comment for this doc item. |
int |
compareTo(Object obj)
Compares this Object with the specified Object for order. |
Tag[] |
firstSentenceTags()
Return the first sentence of the comment as tags. |
String |
getRawCommentText()
Return the full unprocessed text of the comment. |
Tag[] |
inlineTags()
Return comment as tags. |
boolean |
isClass()
Is this Doc item a class. |
boolean |
isConstructor()
Is this Doc item a constructor? False until overridden. |
boolean |
isError()
Is this Doc item a error class? False until overridden. |
boolean |
isException()
Is this Doc item a exception class? False until overridden. |
boolean |
isField()
Is this Doc item a field? False until overridden. |
boolean |
isIncluded()
return true if this Doc is include in the active set. |
boolean |
isInterface()
Is this Doc item a interface? False until overridden. |
boolean |
isMethod()
Is this Doc item a simple method (i.e. |
boolean |
isOrdinaryClass()
Is this Doc item a ordinary class (i.e. |
String |
name()
Returns the non-qualified name of this Doc item. |
SourcePosition |
position()
Return the source position of the documented entity, or null if no position is available. |
SeeTag[] |
seeTags()
Return the see also tags in this Doc item. |
void |
setRawCommentText(String rawDocumentation)
Set the full unprocessed text of the comment. |
Tag[] |
tags()
Return all tags in this Doc item. |
Tag[] |
tags(String tagname)
Return tags of the specified kind in this Doc item. |
Method Detail |
public String commentText()
public Tag[] tags()
public Tag[] tags(String tagname)
tagname
- name of the tag kind to search for.
public SeeTag[] seeTags()
public Tag[] inlineTags()
Tag
of kind "Text".
Inline tags are represented as a SeeTag
of kind "link".
Tag
s representing the commentpublic Tag[] firstSentenceTags()
Tag
of kind "Text".
Inline tags are represented as a SeeTag
of kind "link".
If the locale is English language, the first sentence is
determined by the rules described in the Java Language
Specification (first version): "This sentence ends
at the first period that is followed by a blank, tab, or
line terminator or at the first tagline.", in
addition a line will be terminated by paragraph and
section terminating HTML tags: <p> </p> <h1>
<h2> <h3> <h4> <h5> <h6>
<hr> <pre> or </pre>.
If the locale is not English, the sentence end will be
determined by
java.text.BreakIterator.getSentenceInstance(Locale)
.
Tag
s representing the
first sentence of the commentpublic String getRawCommentText()
public void setRawCommentText(String rawDocumentation)
public String name()
public int compareTo(Object obj)
Included so that Doc item are java.lang.Comparable.
compareTo
in interface Comparable
ClassCastException
- the specified Object's type prevents it
from being compared to this Object.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()
public SourcePosition position()
|
Doclet API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |