| Package | Description | 
|---|---|
| com.sun.source.doctree | Provides interfaces to represent documentation comments as abstract syntax
 trees (AST). | 
| com.sun.source.util | Provides utilities for operations on abstract syntax trees (AST). | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | AttributeTreeA tree node for an attribute in an HTML element. | 
| interface  | AuthorTreeA tree node for an @author block tag. | 
| interface  | BlockTagTreeA tree node used as the base class for the different types of
 block tags. | 
| interface  | CommentTreeAn embedded HTML comment. | 
| interface  | DeprecatedTreeA tree node for an @deprecated block tag. | 
| interface  | DocCommentTreeThe top level representation of a documentation comment. | 
| interface  | DocRootTreeA tree node for an @docroot inline tag. | 
| interface  | EndElementTreeA tree node for the end of an HTML element. | 
| interface  | EntityTreeA tree node for an HTML entity. | 
| interface  | ErroneousTreeA tree node to stand in for a malformed text | 
| interface  | IdentifierTreeAn identifier in a documentation comment. | 
| interface  | InheritDocTreeA tree node for an @inheritDoc inline tag. | 
| interface  | InlineTagTreeA tree node used as the base class for the different types of
 inline tags. | 
| interface  | LinkTreeA tree node for an @link or @linkplain inline tag. | 
| interface  | LiteralTreeA tree node for an @literal or @code inline tag. | 
| interface  | ParamTreeA tree node for an @param block tag. | 
| interface  | ReferenceTreeA tree node to a reference to a Java language element. | 
| interface  | ReturnTreeA tree node for an @return block tag. | 
| interface  | SeeTreeA tree node for an @see block tag. | 
| interface  | SerialDataTreeA tree node for an @serialData block tag. | 
| interface  | SerialFieldTreeA tree node for an @serialData block tag. | 
| interface  | SerialTreeA tree node for an @serial block tag. | 
| interface  | SinceTreeA tree node for an @since block tag. | 
| interface  | StartElementTreeA tree node for the start of an HTML element. | 
| interface  | TextTreeA tree node for plain text. | 
| interface  | ThrowsTreeA tree node for an @exception or @throws block tag. | 
| interface  | UnknownBlockTagTreeA tree node for an unrecognized inline tag. | 
| interface  | UnknownInlineTagTreeA tree node for an unrecognized inline tag. | 
| interface  | ValueTreeA tree node for an @value inline tag. | 
| interface  | VersionTreeA tree node for an @version block tag. | 
| Modifier and Type | Method and Description | 
|---|---|
| List<? extends DocTree> | StartElementTree. getAttributes() | 
| List<? extends DocTree> | DocCommentTree. getBlockTags() | 
| List<? extends DocTree> | VersionTree. getBody() | 
| List<? extends DocTree> | SinceTree. getBody() | 
| List<? extends DocTree> | DocCommentTree. getBody() | 
| List<? extends DocTree> | DeprecatedTree. getBody() | 
| List<? extends DocTree> | UnknownInlineTagTree. getContent() | 
| List<? extends DocTree> | UnknownBlockTagTree. getContent() | 
| List<? extends DocTree> | ThrowsTree. getDescription() | 
| List<? extends DocTree> | SerialFieldTree. getDescription() | 
| List<? extends DocTree> | SerialDataTree. getDescription() | 
| List<? extends DocTree> | SerialTree. getDescription() | 
| List<? extends DocTree> | ReturnTree. getDescription() | 
| List<? extends DocTree> | ParamTree. getDescription() | 
| List<? extends DocTree> | DocCommentTree. getFirstSentence() | 
| List<? extends DocTree> | LinkTree. getLabel() | 
| List<? extends DocTree> | AuthorTree. getName() | 
| List<? extends DocTree> | SeeTree. getReference() | 
| List<? extends DocTree> | AttributeTree. getValue() | 
| Modifier and Type | Method and Description | 
|---|---|
| R | DocTreeVisitor. visitOther(DocTree node,
          P p) | 
| Modifier and Type | Method and Description | 
|---|---|
| DocTree | DocTreePath. getLeaf()Get the leaf node for this path. | 
| Modifier and Type | Method and Description | 
|---|---|
| Iterator<DocTree> | DocTreePath. iterator() | 
| Modifier and Type | Method and Description | 
|---|---|
| protected R | SimpleDocTreeVisitor. defaultAction(DocTree node,
             P p) | 
| long | DocSourcePositions. getEndPosition(CompilationUnitTree file,
              DocCommentTree comment,
              DocTree tree)Gets the ending position of the tree within the comment within the file. | 
| static DocTreePath | DocTreePath. getPath(DocTreePath path,
       DocTree target)Gets a documentation tree path for a tree node within a subtree identified by a DocTreePath object. | 
| static DocTreePath | DocTreePath. getPath(TreePath treePath,
       DocCommentTree doc,
       DocTree target)Gets a documentation tree path for a tree node within a compilation unit. | 
| long | DocSourcePositions. getStartPosition(CompilationUnitTree file,
                DocCommentTree comment,
                DocTree tree)Gets the starting position of the tree within the comment within the file. | 
| abstract void | DocTrees. printMessage(Diagnostic.Kind kind,
            CharSequence msg,
            DocTree t,
            DocCommentTree c,
            CompilationUnitTree root)Prints a message of the specified kind at the location of the
 tree within the provided compilation unit | 
| R | DocTreeScanner. scan(DocTree node,
    P p)Scan a single node. | 
| R | DocTreePathScanner. scan(DocTree tree,
    P p)Scan a single node. | 
| R | SimpleDocTreeVisitor. visit(DocTree node,
     P p) | 
| R | SimpleDocTreeVisitor. visitOther(DocTree node,
          P p) | 
| R | DocTreeScanner. visitOther(DocTree node,
          P p) | 
| Modifier and Type | Method and Description | 
|---|---|
| R | DocTreeScanner. scan(Iterable<? extends DocTree> nodes,
    P p)Scan a list of nodes. | 
| R | SimpleDocTreeVisitor. visit(Iterable<? extends DocTree> nodes,
     P p) | 
| Constructor and Description | 
|---|
| DocTreePath(DocTreePath p,
           DocTree t)Creates a DocTreePath for a child node. | 
 Copyright © 2005, 2025, Oracle and/or its affiliates.  All rights reserved.