Class MultilineCommentLeadingAsteriskPresenceCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.MultilineCommentLeadingAsteriskPresenceCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class MultilineCommentLeadingAsteriskPresenceCheck extends AbstractCheck
Checks if the multi-line comments have leading asterisks on each line.

Every line in multi-line comment should have leading asterisk including blank line.

Since:
13.9.0

  • Field Details

    • MSG_MISSING_ASTERISK

      public static final String MSG_MISSING_ASTERISK
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:

  • Constructor Details

    • MultilineCommentLeadingAsteriskPresenceCheck

      public MultilineCommentLeadingAsteriskPresenceCheck()
      Creates a new MultilineCommentLeadingAsteriskPresenceCheck instance.

  • Method Details

    • getRequiredTokens

      public int[] getRequiredTokens()
      Description copied from class: AbstractCheck
      The tokens that this check must be registered for.
      Specified by:
      getRequiredTokens in class AbstractCheck
      Returns:
      the token set this must be registered for.
      See Also:

    • getAcceptableTokens

      public int[] getAcceptableTokens()
      Description copied from class: AbstractCheck
      The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.
      Specified by:
      getAcceptableTokens in class AbstractCheck
      Returns:
      the token set this check is designed for.
      See Also:

    • getDefaultTokens

      public int[] getDefaultTokens()
      Description copied from class: AbstractCheck
      Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
      Specified by:
      getDefaultTokens in class AbstractCheck
      Returns:
      the default tokens
      See Also:

    • isCommentNodesRequired

      public boolean isCommentNodesRequired()
      Description copied from class: AbstractCheck
      Whether comment nodes are required or not.
      Overrides:
      isCommentNodesRequired in class AbstractCheck
      Returns:
      false as a default value.

    • visitToken

      public void visitToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called to process a token.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process