Uses of Interface
com.sun.source.doctree.DocCommentTree
Package
Description
Provides interfaces to represent documentation comments as abstract syntax
trees (AST).
Provides utilities for operations on abstract syntax trees (AST).
-
Uses of DocCommentTree in com.sun.source.doctree
Modifier and TypeMethodDescriptionDocTreeVisitor.visitDocComment(DocCommentTree node, P p)
Visits a DocCommentTree node. -
Uses of DocCommentTree in com.sun.source.util
Modifier and TypeMethodDescriptionDocTreePath.getDocComment()
Returns theDocCommentTree
associated with this path.abstract DocCommentTree
DocTrees.getDocCommentTree(TreePath path)
Returns the doc comment tree, if any, for the Tree node identified by a given TreePath.abstract DocCommentTree
DocTrees.getDocCommentTree(Element e)
Returns the doc comment tree of the given element.abstract DocCommentTree
DocTrees.getDocCommentTree(Element e, String relativePath)
Returns the doc comment tree of the given file whose path is specified relative to the given element.abstract DocCommentTree
DocTrees.getDocCommentTree(FileObject fileObject)
Returns the doc comment tree of the given file.DocTreeFactory.newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags)
Creates a newDocCommentTree
object, to represent a complete doc comment.DocTreeFactory.newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble)
Creates a newDocCommentTree
object, to represent the entire doc comment.Modifier and TypeMethodDescriptionlong
DocSourcePositions.getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)
Returns the ending position of the tree within the comment within the file.static DocTreePath
DocTreePath.getPath(TreePath treePath, DocCommentTree doc, DocTree target)
Returns a documentation tree path for a tree node within a compilation unit, ornull
if the node is not found.long
DocSourcePositions.getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)
Returns 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 unitDocTreeScanner.visitDocComment(DocCommentTree node, P p)
Visits a DocCommentTree node.SimpleDocTreeVisitor.visitDocComment(DocCommentTree node, P p)
Visits a DocCommentTree node.ModifierConstructorDescriptionDocTreePath(TreePath treePath, DocCommentTree t)
Creates aDocTreePath
for a root node.