Updated documentation of Parser fields

This commit is contained in:
Sam Harwell 2013-03-26 17:02:14 -05:00
parent cb6207e707
commit 1d3910a78b
1 changed files with 31 additions and 13 deletions

View File

@ -93,30 +93,48 @@ public abstract class Parser extends Recognizer<Token, ParserATNSimulator> {
} }
} }
/**
* The error handling strategy for the parser. The default value is a new
* instance of {@link DefaultErrorStrategy}.
*
* @see #getErrorHandler
* @see #setErrorHandler
*/
@NotNull @NotNull
protected ANTLRErrorStrategy _errHandler = new DefaultErrorStrategy(); protected ANTLRErrorStrategy _errHandler = new DefaultErrorStrategy();
/**
* The input stream.
*
* @see #getInputStream
* @see #setInputStream
*/
protected TokenStream _input; protected TokenStream _input;
/** The RuleContext object for the currently executing rule. This /**
* must be non-null during parsing, but is initially null. * The {@link ParserRuleContext} object for the currently executing rule.
* When somebody calls the start rule, this gets set to the * This is always non-null during the parsing process.
* root context.
*/ */
protected ParserRuleContext _ctx; protected ParserRuleContext _ctx;
/**
* Specifies whether or not the parser should construct a parse tree during
* the parsing process. The default value is {@code true}.
*
* @see #getBuildParseTree
* @see #setBuildParseTree
*/
protected boolean _buildParseTrees = true; protected boolean _buildParseTrees = true;
protected TraceListener _tracer; protected TraceListener _tracer;
/** If the listener is non-null, trigger enter and exit rule events /**
* *during* the parse. This is typically done only when not building * The list of {@link ParseTreeListener} listeners registered to receive
* parse trees for later visiting. We either trigger events during * events during the parse.
* the parse or during tree walks later. Both could be done. *
* Not intended for average user!!! Most people should use * @see #addParseListener
* ParseTreeListener with ParseTreeWalker.
* @see ParseTreeWalker
*/ */
@Nullable
protected List<ParseTreeListener> _parseListeners; protected List<ParseTreeListener> _parseListeners;
/** /**