Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class MissingJavadocPackageCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class MissingJavadocPackageCheck extends AbstractCheck

Checks for missing Javadoc comments in package-info.java files.

Rationale: description and other related documentation for a package can be written up in the package-info.java file and it gets used in the production of the Javadocs. See link for more info.

To configure the check: 

 <module name="MissingJavadocPackage"/>

Example:

 /**
 * Provides API classes
 */
 package com.checkstyle.api; // no violation
 /*
 * Block comment is not a javadoc
 */
 package com.checkstyle.api; // violation

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • package.javadoc.missing
Since:
8.22

  • Field Details

    • MSG_PKG_JAVADOC_MISSING

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

  • Constructor Details

    • MissingJavadocPackageCheck

      public MissingJavadocPackageCheck()

  • Method Details

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

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

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

    • 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