org.jsesoft.jpp
Class DocumentationCommentState

java.lang.Object
  |
  +--org.jsesoft.jpp.State
        |
        +--org.jsesoft.jpp.TraditionalCommentState
              |
              +--org.jsesoft.jpp.DocumentationCommentState

public class DocumentationCommentState

extends TraditionalCommentState

Scans a documentation comment from the reader.

Version:

1.0

Author:

JSESoft

Fields inherited from class org.jsesoft.jpp.TraditionalCommentState

buffer, shouldIgnore

Constructor Summary

DocumentationCommentState()

DocumentationCommentState(boolean shouldIgnore)

Method Summary

Token	nextToken(java.io.PushbackReader reader, int first, Tokenizer tokenizer) Scans documentation comment from reader.
protected java.lang.String	prefix()

Methods inherited from class org.jsesoft.jpp.TraditionalCommentState

checkBuffer, setShouldIgnore

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentationCommentState

public DocumentationCommentState()

DocumentationCommentState

public DocumentationCommentState(boolean shouldIgnore)

Method Detail

nextToken

public Token nextToken(java.io.PushbackReader reader,
                       int first,
                       Tokenizer tokenizer)
                throws java.io.IOException

Scans documentation comment from reader.

Overrides:

nextToken in class TraditionalCommentState

Parameters:

reader - the reader to read characters from

first - the character starting the token

tokenizer - the tokenizer in duty

Returns:

the next token

Throws:

java.io.IOException - on any problem reading

prefix

protected java.lang.String prefix()

Overrides:

prefix in class TraditionalCommentState