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

Class 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 Detail

      • MSG_PKG_JAVADOC_MISSING

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

    • Constructor Detail

      • MissingJavadocPackageCheck

        public MissingJavadocPackageCheck()

    • Method Detail

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

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

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

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