Class JavadocDetailNodeParser

java.lang.Object
com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser

public class JavadocDetailNodeParser extends Object
Used for parsing Javadoc comment as DetailNode tree.
  • Field Details

    • 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:
    • MSG_JAVADOC_WRONG_SINGLETON_TAG

      public static final String MSG_JAVADOC_WRONG_SINGLETON_TAG
      Message key of error message.
      See Also:
    • MSG_JAVADOC_PARSE_RULE_ERROR

      public static final String MSG_JAVADOC_PARSE_RULE_ERROR
      Parse error while rule recognition.
      See Also:
    • MSG_UNCLOSED_HTML_TAG

      public static final String MSG_UNCLOSED_HTML_TAG
      Message property key for the Unclosed HTML message.
      See Also:
  • Constructor Details

    • JavadocDetailNodeParser

      public JavadocDetailNodeParser()
  • Method Details

    • 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