| java.lang.Object com.sun.tools.javac.parser.Scanner com.sun.tools.javac.parser.DocCommentScanner
DocCommentScanner | public class DocCommentScanner extends Scanner (Code) | | An extension to the base lexical analyzer that captures
and processes the contents of doc comments. It does so by
translating Unicode escape sequences and by stripping the
leading whitespace and starts from each line of the comment.
This is NOT part of any API supported by Sun Microsystems. 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.
|
Constructor Summary | |
protected | DocCommentScanner(Factory fac, CharBuffer buffer) Create a scanner from the input buffer. | protected | DocCommentScanner(Factory fac, char[] input, int inputLength) Create a scanner from the input array. |
Method Summary | |
public String | docComment() Returns the documentation string of the current token. | public Position.LineMap | getLineMap() Build a map for translating between line numbers and
positions in the input. | public void | nextToken() | protected void | processComment(CommentStyle style) Process a doc comment and make the string content available. |
DocCommentScanner | protected DocCommentScanner(Factory fac, CharBuffer buffer)(Code) | | Create a scanner from the input buffer. buffer must implement
array() and compact(), and remaining() must be less than limit().
|
DocCommentScanner | protected DocCommentScanner(Factory fac, char[] input, int inputLength)(Code) | | Create a scanner from the input array. The array must have at
least a single character of extra space.
|
docComment | public String docComment()(Code) | | Returns the documentation string of the current token.
|
getLineMap | public Position.LineMap getLineMap()(Code) | | Build a map for translating between line numbers and
positions in the input.
a LineMap |
nextToken | public void nextToken()(Code) | | |
processComment | protected void processComment(CommentStyle style)(Code) | | Process a doc comment and make the string content available.
Strips leading whitespace and stars.
|
Fields inherited from com.sun.tools.javac.parser.Scanner | protected boolean deprecatedFlag(Code)(Java Doc) final static boolean surrogatesSupported(Code)(Java Doc)
|
|
|