Package com.puppycrawl.tools.checkstyle
Class JavadocDetailNodeParser
java.lang.Object
com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser
Used for parsing Javadoc comment as DetailNode tree.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Contains information about parse error message.static class
Contains result of parsing javadoc comment: DetailNode tree and parse error message. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionparseJavadocAsDetailNode
(DetailAST javadocCommentAst) Parses Javadoc comment as DetailNode tree.
-
Field Details
-
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:
-
MSG_JAVADOC_WRONG_SINGLETON_TAG
Message key of error message.- See Also:
-
MSG_JAVADOC_PARSE_RULE_ERROR
Parse error while rule recognition.- See Also:
-
MSG_UNCLOSED_HTML_TAG
Message property key for the Unclosed HTML message.- See Also:
-
-
Constructor Details
-
JavadocDetailNodeParser
public JavadocDetailNodeParser()
-
-
Method Details
-
parseJavadocAsDetailNode
Parses Javadoc comment as DetailNode tree.- Parameters:
javadocCommentAst
- DetailAST of Javadoc comment- Returns:
- DetailNode tree of Javadoc comment
-