Package com.sun.tools.javac.tree

Interface DocCommentTable

All Known Implementing Classes:

LazyDocCommentTable

public interface DocCommentTable

A table giving the doc comment, if any, for any tree node.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Method Summary

Modifier and Type	Method and Description
Tokens.Comment	getComment(JCTree tree) Get the Comment token containing the doc comment, if any, for a tree node.
String	getCommentText(JCTree tree) Get the plain text of the doc comment, if any, for a tree node.
DCTree.DCDocComment	getCommentTree(JCTree tree) Get the parsed form of the doc comment as a DocTree.
boolean	hasComment(JCTree tree) Check if a tree node has a corresponding doc comment.
void	putComment(JCTree tree, Tokens.Comment c) Set the Comment to be associated with a tree node.

Method Detail

hasComment

boolean hasComment(JCTree tree)

Check if a tree node has a corresponding doc comment.

getComment

Tokens.Comment getComment(JCTree tree)

Get the Comment token containing the doc comment, if any, for a tree node.

getCommentText

String getCommentText(JCTree tree)

Get the plain text of the doc comment, if any, for a tree node.

getCommentTree

DCTree.DCDocComment getCommentTree(JCTree tree)

Get the parsed form of the doc comment as a DocTree. If any errors are detected during parsing, they will be reported via ErroneousTree nodes within the resulting tree.

putComment

void putComment(JCTree tree,
                Tokens.Comment c)

Set the Comment to be associated with a tree node.