Package org.eclipse.jdt.core.dom

Class Javadoc

java.lang.Object
org.eclipse.jdt.core.dom.ASTNode
org.eclipse.jdt.core.dom.Comment
org.eclipse.jdt.core.dom.Javadoc
public class Javadoc extends Comment
AST node for a Javadoc-style doc comment. 
 Javadoc:
   /**  { TagElement } */
Since:
2.0
Restriction:
This class is not intended to be instantiated by clients.

  • Field Details

    • COMMENT_PROPERTY

      public static final SimplePropertyDescriptor COMMENT_PROPERTY
      Deprecated.
      Replaced by TAGS_PROPERTY in the JLS3 API.
      The "comment" structural property of this node type (type: String) (JLS2 API only).
      Since:
      3.0

    • TAGS_PROPERTY

      public static final ChildListPropertyDescriptor TAGS_PROPERTY
      The "tags" structural property of this node type (element type: TagElement).
      Since:
      3.1

    • MARKDOWN_PROPERTY

      public static final SimplePropertyDescriptor MARKDOWN_PROPERTY
      The "markdown" structural property of this node type (type: Boolean) (added in JLS23 API).
      Since:
      3.40
      Restriction:
      This field belongs to a preview feature and is not intended to be referenced by clients

  • Method Details

    • propertyDescriptors

      public static List propertyDescriptors(int apiLevel)
      Returns a list of structural property descriptors for this node type. Clients must not modify the result.
      Parameters:
      apiLevel - the API level; one of the AST.JLS* constants
      Returns:
      a list of property descriptors (element type: StructuralPropertyDescriptor)
      Since:
      3.0

    • getComment

      public String getComment()
      Deprecated.
      The comment string was replaced in the 3.0 release by a representation of the structure of the doc comment. See tags.
      Returns the doc comment string, including the starting and ending comment delimiters, and any embedded line breaks.
      Returns:
      the doc comment string
      Throws:
      UnsupportedOperationException - if this operation is used in an AST later than JLS2

    • setComment

      public void setComment(String docComment)
      Deprecated.
      The comment string was replaced in the 3.0 release by a representation of the structure of the doc comment. See tags.
      Sets or clears the doc comment string. The documentation string must include the starting and ending comment delimiters, and any embedded line breaks.
      Parameters:
      docComment - the doc comment string
      Throws:
      IllegalArgumentException - if the Java comment string is invalid
      UnsupportedOperationException - if this operation is used in an AST later than JLS2

    • tags

      public List tags()
      Returns the live list of tag elements that make up this doc comment.

      The tag elements cover everything except the starting and ending comment delimiters, and generally omit leading whitespace (including a leading "*") and embedded line breaks. The first tag element of a typical doc comment represents all the material before the first explicit doc tag; this first tag element has a null tag name and generally contains 1 or more AbstractTextElements, and possibly interspersed with tag elements for nested tags like "String". Subsequent tag elements represent successive top-level doc tag (e.g., "@param", "@return", "@see").

      Adding and removing nodes from this list affects this node dynamically.

      Returns:
      the live list of tag elements in this doc comment (element type: TagElement)
      Since:
      3.0

    • isMarkdown

      public boolean isMarkdown()
      Returns whether this javadoc is a markdown comment (added in JLS23 API).
      Returns:
      true if this is a markdown comment, and false if this is a traditional javadoc comment.
      Since:
      3.39
      Restriction:
      preview feature

    • setMarkdown

      public void setMarkdown(boolean isMarkdown)
      Sets whether this javadoc is a markdown comment (added in JLS23 API).
      Parameters:
      isMarkdown - true if this is a markdown comment, and false if this is a traditional javadoc comment.
      Since:
      3.39
      Restriction:
      preview feature