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

    • Method Detail

      • 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

      • hasJavadoc

        private static boolean hasJavadoc​(DetailAST ast)
        Checks that there is javadoc before ast. Because of parser bug parser can place javadoc comment either as previous sibling of package definition or (if there is annotation between package def and javadoc) inside package definition tree. So we should look for javadoc in both places.
        Parameters:
        ast - TokenTypes.PACKAGE_DEF token to check
        Returns:
        true if there is javadoc, false otherwise

      • hasJavadocAboveAnnotation

        private static boolean hasJavadocAboveAnnotation​(DetailAST ast)
        Checks javadoc existence in annotations list.
        Parameters:
        ast - package def
        Returns:
        true if there is a javadoc, false otherwise

      • isJavadoc

        private static boolean isJavadoc​(DetailAST ast)
        Checks that ast is a javadoc comment.
        Parameters:
        ast - token to check
        Returns:
        true if ast is a javadoc comment, false otherwise