public interface Doc extends Comparable<Object>
| Modifier and Type | Method and Description | 
|---|---|
| String | commentText()Return the text of the comment for this doc item. | 
| int | compareTo(Object obj)Compares this doc object with the specified object for order. | 
| Tag[] | firstSentenceTags()Return the first sentence of the comment as an array of tags. | 
| String | getRawCommentText()Return the full unprocessed text of the comment. | 
| Tag[] | inlineTags()Return comment as an array of tags. | 
| boolean | isAnnotationType()Is this Doc item an annotation type? | 
| boolean | isAnnotationTypeElement()Is this Doc item an annotation type element? | 
| boolean | isClass()Is this Doc item a
 class
 (and not an interface or annotation type)? | 
| boolean | isConstructor()Is this Doc item a constructor? | 
| boolean | isEnum()Is this Doc item an enum type? | 
| boolean | isEnumConstant()Is this Doc item an enum constant? | 
| boolean | isError()Is this Doc item an error class? | 
| boolean | isException()Is this Doc item an exception class? | 
| boolean | isField()Is this Doc item a field (but not an enum constant)? | 
| boolean | isIncluded()Return true if this Doc item is
 included
 in the result set. | 
| boolean | isInterface()Is this Doc item an interface (but not an annotation type)? | 
| boolean | isMethod()Is this Doc item a method (but not a constructor or annotation
 type element)? | 
| boolean | isOrdinaryClass()Is this Doc item an
 ordinary
 class? | 
| String | name()Returns the non-qualified name of this Doc item. | 
| SourcePosition | position()Return the source position of the first line of the
 corresponding declaration, 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. | 
String commentText()
Tag[] tags()
Tag objects containing all tags on
         this Doc item.Tag[] tags(String tagname)
tagname - name of the tag kind to search for.SeeTag[] seeTags()
Tag[] inlineTags()
Tag
 of kind "Text".
 Inline tags are represented as a SeeTag of kind "@see"
 and name "@link".Tags representing the commentTag[] firstSentenceTags()
Tag
 of kind "Text".
 Inline tags are represented as a SeeTag of kind "@see"
 and name "@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 block
 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
 BreakIterator.getSentenceInstance(Locale).
Tags representing the
 first sentence of the commentString getRawCommentText()
void setRawCommentText(String rawDocumentation)
String name()
int compareTo(Object obj)
 This method satisfies the Comparable interface.
compareTo in interface Comparable<Object>obj - the Object to be compared.ClassCastException - the specified Object's type prevents it
        from being compared to this Object.boolean isField()
boolean isEnumConstant()
boolean isConstructor()
boolean isMethod()
boolean isAnnotationTypeElement()
boolean isInterface()
boolean isException()
boolean isError()
boolean isEnum()
boolean isAnnotationType()
boolean isOrdinaryClass()
boolean isClass()
boolean isIncluded()
SourcePosition position()
 Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
 Copyright © 1993, 2025, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.