| Method Summary |
|
| Comment | comment()
For lazy initialization of comment. |
| public String | commentText()
Return the text of the comment for this doc item. |
| public int | compareTo(Object obj)
Compares this Object with the specified Object for order. |
| String | documentation()
So subclasses have the option to do lazy initialization of
"documentation" string. |
| public Tag[] | firstSentenceTags()
|
| CollationKey | generateKey()
Generate a key for sorting. |
| public String | getRawCommentText()
Return the full unprocessed text of the comment. |
| public Tag[] | inlineTags()
|
| public boolean | isAnnotationType()
Is this Doc item an annotation type? False until overridden. |
| public boolean | isAnnotationTypeElement()
Is this Doc item an annotation type element?
False until overridden. |
| public boolean | isClass()
Is this Doc item a class
(and not an interface or annotation type)?
This includes ordinary classes, enums, errors and exceptions. |
| public boolean | isConstructor()
Is this Doc item a constructor? False until overridden. |
| public boolean | isEnum()
Is this Doc item an enum type? False until overridden. |
| public boolean | isEnumConstant()
Is this Doc item an enum constant? False until overridden. |
| public boolean | isError()
Is this Doc item a error class? False until overridden. |
| public boolean | isException()
Is this Doc item a exception class? False until overridden. |
| public boolean | isField()
Is this Doc item a field? False until overridden. |
| abstract public boolean | isIncluded()
return true if this Doc is include in the active set. |
| public boolean | isInterface()
Is this Doc item a interface (but not an annotation type)?
False until overridden. |
| public boolean | isMethod()
Is this Doc item a method (but not a constructor or annotation
type element)?
False until overridden. |
| public boolean | isOrdinaryClass()
Is this Doc item an ordinary class (i.e. |
| CollationKey | key()
return a key for sorting. |
| abstract public String | name()
Returns the name of this Doc item. |
| public SourcePosition | position()
Return the source position of the entity, or null if
no position is available. |
| abstract public String | qualifiedName()
Returns the qualified name of this Doc item. |
| String | readHTMLDocumentation(InputStream input, String filename)
Utility for subclasses which read HTML documentation files. |
| public SeeTag[] | seeTags()
Return the see also tags in this Doc item. |
| public void | setRawCommentText(String rawDocumentation)
Set the full unprocessed text of the comment. |
| public Tag[] | tags()
Return all tags in this Doc item. |
| public Tag[] | tags(String tagname)
Return tags of the specified kind in this Doc item.
Parameters:
tagname - name of the tag kind to search for. |
| public String | toString()
Returns a string representation of this Doc item. |
