Package com.qulice.checkstyle

Class JavadocCompactParagraphCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.qulice.checkstyle.JavadocCompactParagraphCheck
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable
public final class JavadocCompactParagraphCheck extends com.puppycrawl.tools.checkstyle.api.AbstractCheck
Check for compact paragraph tags in Javadoc.

The built-in JavadocParagraph module governs the blank lines around <p>, but nothing stops the tag from sitting alone on its own line. This check keeps <p> glued to the text it opens and </p> glued to the text it closes, while JavadocUnclosedParagraphCheck is the one that insists on the closing tag being there. So a line whose trimmed content ends with <p>, or whose trimmed content starts with </p>, is reported as a violation. See #1709.

The following Javadoc will be reported as a violation, since the opening tag ends a line and the closing tag starts a line:

 /**
  * <p>
  * An example of how to configure the check is:
  * </p>
  */

And this is how it should be written instead:

 /**
  * <p>An example of how to configure the check is:</p>
  */

Lines inside a <pre>...</pre> block or a {@snippet ...} block are skipped, since a literal <p> or </p> may appear there as example content rather than as a real tag.

Since:
0.73.3

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

    com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.OutputStreamOptions

  • Constructor Summary

    Constructors
    Constructor
    Description
    JavadocCompactParagraphCheck()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    int[]
    getAcceptableTokens()
     
    int[]
    getDefaultTokens()
     
    int[]
    getRequiredTokens()
     
    void
    visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
     

    Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

    beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

    Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

    finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

    Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

    configure, contextualize, getConfiguration, setupChild

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • JavadocCompactParagraphCheck

      public JavadocCompactParagraphCheck()
      Default constructor.

  • Method Details

    • getDefaultTokens

      public int[] getDefaultTokens()
      Specified by:
      getDefaultTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

    • getAcceptableTokens

      public int[] getAcceptableTokens()
      Specified by:
      getAcceptableTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

    • getRequiredTokens

      public int[] getRequiredTokens()
      Specified by:
      getRequiredTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

    • visitToken

      public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
      Overrides:
      visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck