com.puppycrawl.tools.checkstyle

Class JavadocDetailNodeParser

java.lang.Object

com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser

public class JavadocDetailNodeParser
extends Object

Used for parsing Javadoc comment as DetailNode tree.

Author:

bizmailov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavadocDetailNodeParser.ParseErrorMessage Contains information about parse error message.
static class	JavadocDetailNodeParser.ParseStatus Contains result of parsing javadoc comment: DetailNode tree and parse error message.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_JAVADOC_MISSED_HTML_CLOSE Message key of error message.
static String	MSG_JAVADOC_PARSE_RULE_ERROR Parse error while rule recognition.
static String	MSG_JAVADOC_WRONG_SINGLETON_TAG Message key of error message.
static String	MSG_UNCLOSED_HTML_TAG Message property key for the Unclosed HTML message.

Constructor Summary

Constructors

Constructor and Description
JavadocDetailNodeParser()

Method Summary

Modifier and Type	Method and Description
JavadocDetailNodeParser.ParseStatus	parseJavadocAsDetailNode(DetailAST javadocCommentAst) Parses Javadoc comment as DetailNode tree.

Methods inherited from class java.lang.Object

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

Field Detail

MSG_JAVADOC_MISSED_HTML_CLOSE

public static final String MSG_JAVADOC_MISSED_HTML_CLOSE

Message key of error message. Missed close HTML tag breaks structure of parse tree, so parser stops parsing and generates such error message. This case is special because parser prints error like "no viable alternative at input 'b \n *\n'" and it is not clear that error is about missed close HTML tag.

See Also:

Constant Field Values

MSG_JAVADOC_WRONG_SINGLETON_TAG

public static final String MSG_JAVADOC_WRONG_SINGLETON_TAG

Message key of error message.

See Also:

Constant Field Values

MSG_JAVADOC_PARSE_RULE_ERROR

public static final String MSG_JAVADOC_PARSE_RULE_ERROR

Parse error while rule recognition.

See Also:

Constant Field Values

MSG_UNCLOSED_HTML_TAG

public static final String MSG_UNCLOSED_HTML_TAG

Message property key for the Unclosed HTML message.

See Also:

Constant Field Values

Constructor Detail

JavadocDetailNodeParser

public JavadocDetailNodeParser()

Method Detail

parseJavadocAsDetailNode

public JavadocDetailNodeParser.ParseStatus parseJavadocAsDetailNode(DetailAST javadocCommentAst)

Parses Javadoc comment as DetailNode tree.

Parameters:

javadocCommentAst - DetailAST of Javadoc comment

Returns:

DetailNode tree of Javadoc comment