Uses of Interface com.sun.source.doctree.DocCommentTree (Compiler Tree API )
Date: 2020-03-26

## Uses of Interface
com.sun.source.doctree.DocCommentTree

- Packages that use DocCommentTree
  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).

- - ### Uses of DocCommentTree in com.sun.source.doctree

    Methods in com.sun.source.doctree with parameters of type DocCommentTree
    Modifier and Type | Method and Description
    --- | ---
    `R` | DocTreeVisitor.`visitDocComment(DocCommentTree node, P p)`

  - ### Uses of DocCommentTree in com.sun.source.util

    Methods in com.sun.source.util that return DocCommentTree
    Modifier and Type | Method and Description
    --- | ---
    `DocCommentTree` | DocTreePath.`getDocComment()` Get the DocCommentTree associated with this path.
    `abstract DocCommentTree` | DocTrees.`getDocCommentTree(TreePath path)` Gets the doc comment tree, if any, for the Tree node identified by a given TreePath.

    Methods in com.sun.source.util with parameters of type DocCommentTree
    Modifier and Type | Method and Description
    --- | ---
    `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(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` | SimpleDocTreeVisitor.`visitDocComment(DocCommentTree node, P p)`
    `R` | DocTreeScanner.`visitDocComment(DocCommentTree node, P p)`

    Constructors in com.sun.source.util with parameters of type DocCommentTree
    Constructor and Description
    `DocTreePath(TreePath treePath, DocCommentTree t)` Creates a DocTreePath for a root node.

Copyright © 2005, 2020, Oracle and/or its affiliates. All rights reserved.