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 | Method | Description |
---|---|---|
R |
DocTreeVisitor.visitDocComment(DocCommentTree node,
P p) |
Visits a DocCommentTree node.
|
Modifier and Type | Method | Description |
---|---|---|
DocCommentTree |
DocTreePath.getDocComment() |
Returns the DocCommentTree 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.
|
DocCommentTree |
DocTreeFactory.newDocCommentTree(List<? extends DocTree> fullBody,
List<? extends DocTree> tags) |
Create a new
DocCommentTree object, to represent a complete doc comment. |
Modifier and Type | Method | Description |
---|---|---|
long |
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,
or
null 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 unit
|
R |
DocTreeScanner.visitDocComment(DocCommentTree node,
P p) |
Visits a DocCommentTree node.
|
R |
SimpleDocTreeVisitor.visitDocComment(DocCommentTree node,
P p) |
Visits a DocCommentTree node.
|
Constructor | Description |
---|---|
DocTreePath(TreePath treePath,
DocCommentTree t) |
Creates a DocTreePath for a root node.
|
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 © 2005, 2016, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-Debian+0-9b149-1