Jalopy Java Source Code Formatter 1.0b10 API: Class JavadocParser

Overview

Package

Class

Use

Tree

Deprecated

Index

Jalopy 1.0b10

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.hunsicker.jalopy.language
Class JavadocParser

java.lang.Object
  |
  +--de.hunsicker.antlr.Parser
        |
        +--de.hunsicker.antlr.LLkParser
              |
              +--de.hunsicker.jalopy.language.JavadocParser

All Implemented Interfaces:: Parser

public final class JavadocParser
extends LLkParser
implements Parser

Parser for Javadoc comments.

Sample Usage:

 
  // an input source
  Reader in = new BufferedReader(new FileReader(new File(argv[0])));
 
  // create a lexer
  Lexer lexer = new JavadocLexer();
 
  // set up the lexer to read from the input source
  lexer.setInputBuffer(in);
 
  // get the corresponding parser
  Parser parser = lexer.getParser();
 
  // and start the parsing process
  parser.parse();

This is an ANTLR automated generated file. DO NOT EDIT but rather change the associated grammar (java.doc.g) and rebuild.

Version:: 1.0
Author:: Marco Hunsicker
See Also:: JavadocLexer, Recognizer

Field Summary

static String[] _tokenNames
          DOCUMENT ME!

static Node EMPTY_JAVADOC_COMMENT
          The empty Javadoc comment.

Fields inherited from class de.hunsicker.antlr.Parser

astFactory, inputState, returnAST, tokenNames, traceDepth

Constructor Summary

JavadocParser(ParserSharedInputState state)
          Creates a new JavadocParser object.

JavadocParser(TokenBuffer tokenBuf)
          Creates a new JavadocParser object.

protected JavadocParser(TokenBuffer tokenBuf, int k)
          Creates a new JavadocParser object.

JavadocParser(TokenStream lexer)
          Creates a new JavadocParser object.

protected JavadocParser(TokenStream lexer, int k)
          Creates a new JavadocParser object.

Method Summary

void acronym()
          DOCUMENT ME!

void address()
          DOCUMENT ME!

void anchor_content()
          DOCUMENT ME!

void anchor()
          DOCUMENT ME!

void big()
          DOCUMENT ME!

void block()
          DOCUMENT ME!

void blockquote()
          DOCUMENT ME!

void body_content()
          DOCUMENT ME!

void body_tag()
          DOCUMENT ME!

void bold()
          DOCUMENT ME!

void caption()
          DOCUMENT ME!

void center()
          DOCUMENT ME!

void citation()
          DOCUMENT ME!

void code()
          DOCUMENT ME!

void dd()
          DOCUMENT ME!

void def_list_item()
          DOCUMENT ME!

void def_list()
          DOCUMENT ME!

void definition()
          DOCUMENT ME!

void dir()
          DOCUMENT ME!

void div()
          DOCUMENT ME!

void dt()
          DOCUMENT ME!

void emphasize()
          DOCUMENT ME!

void font_dfn()
          DOCUMENT ME!

void font()
          DOCUMENT ME!

AST getParseTree()
          DOCUMENT ME!

void h1()
          DOCUMENT ME!

void h2()
          DOCUMENT ME!

void h3()
          DOCUMENT ME!

void h4()
          DOCUMENT ME!

void h5()
          DOCUMENT ME!

void h6()
          DOCUMENT ME!

void handleRecoverableError(RecognitionException ex)
          Handler for recoverable errors.

void heading_content()
          DOCUMENT ME!

void heading()
          DOCUMENT ME!

void inline_tag()
          DOCUMENT ME!

void italic()
          DOCUMENT ME!

void keyboard()
          DOCUMENT ME!

void list_item()
          DOCUMENT ME!

void list()
          DOCUMENT ME!

void ordered_list()
          DOCUMENT ME!

void paragraph()
          DOCUMENT ME!

void parse()
          DOCUMENT ME!

void phrase()
          DOCUMENT ME!

void preformatted()
          DOCUMENT ME!

void reportError(RecognitionException ex)
          Reports the given error.

void reportError(String message)
          Reports the given error.

void reportWarning(String message)
          Reports the given warning.

void reset()
          Resets the parser.

void sample()
          DOCUMENT ME!

void setCustomInlineTags(Collection tags)
          Sets the custom Javadoc in-line tags to recognize.

void setCustomStandardTags(Collection tags)
          Sets the custom Javadoc standard tags to recognize.

void setLexer(JavadocLexer lexer)
          Sets the corresponding Javadoc lexer for the parser.

void small()
          DOCUMENT ME!

void special()
          DOCUMENT ME!

void standard_tag()
          DOCUMENT ME!

void strike()
          DOCUMENT ME!

void strong()
          DOCUMENT ME!

void subscript()
          DOCUMENT ME!

void superscript()
          DOCUMENT ME!

void table()
          DOCUMENT ME!

void teletype()
          DOCUMENT ME!

void text_tag()
          DOCUMENT ME!

void text()
          DOCUMENT ME!

void th_or_td()
          DOCUMENT ME!

void tr()
          DOCUMENT ME!

void underline()
          DOCUMENT ME!

void unordered_list()
          DOCUMENT ME!

void variable()
          DOCUMENT ME!

Methods inherited from class de.hunsicker.antlr.LLkParser

consume, LA, LT, traceIn, traceOut

Methods inherited from class de.hunsicker.antlr.Parser

addMessageListener, addParserListener, addParserMatchListener, addParserTokenListener, addSemanticPredicateListener, addSyntacticPredicateListener, addTraceListener, consumeUntil, consumeUntil, defaultDebuggingSetup, getAST, getASTFactory, getFilename, getInputState, getTokenName, getTokenNames, isDebugMode, mark, match, match, matchNot, panic, removeMessageListener, removeParserListener, removeParserMatchListener, removeParserTokenListener, removeSemanticPredicateListener, removeSyntacticPredicateListener, removeTraceListener, rewind, setASTFactory, setASTNodeClass, setASTNodeType, setDebugMode, setFilename, setIgnoreInvalidDebugCalls, setInputState, setTokenBuffer, traceIndent

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hunsicker.jalopy.language.Parser

getASTFactory, getFilename, getTokenNames, setASTFactory, setFilename, setTokenBuffer

Field Detail

EMPTY_JAVADOC_COMMENT

public static final Node EMPTY_JAVADOC_COMMENT

The empty Javadoc comment.

_tokenNames

public static final String[] _tokenNames

DOCUMENT ME!

Constructor Detail