Home » openjdk-7 » com.sun.tools » javac » parser » [javadoc | source]
com.sun.tools.javac.parser
public class: DocCommentScanner [javadoc | source]
java.lang.Object
   com.sun.tools.javac.parser.Scanner
      com.sun.tools.javac.parser.DocCommentScanner

All Implemented Interfaces:
    Lexer

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 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.
Fields inherited from com.sun.tools.javac.parser.Scanner:
deprecatedFlag,  surrogatesSupported
Constructor:
 protected DocCommentScanner(ScannerFactory fac,
    CharBuffer buffer) 
    Create a scanner from the input buffer. buffer must implement array() and compact(), and remaining() must be less than limit().
 protected DocCommentScanner(ScannerFactory fac,
    char[] input,
    int inputLength) 
    Create a scanner from the input array. The array must have at least a single character of extra space.
Method from com.sun.tools.javac.parser.DocCommentScanner Summary:
docComment,   getLineMap,   nextToken,   processComment
Methods from com.sun.tools.javac.parser.Scanner:
deprecatedFlag,   docComment,   endPos,   errPos,   errPos,   getLineMap,   getRawCharacters,   getRawCharacters,   name,   nextToken,   pos,   prevEndPos,   processComment,   processLineTerminator,   processWhiteSpace,   radix,   resetDeprecatedFlag,   stringVal,   token,   token
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.sun.tools.javac.parser.DocCommentScanner Detail:
 public String docComment() 
    Returns the documentation string of the current token.
 public 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. Strips leading whitespace and stars.