Class JavadocPackageCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable, FileSetCheck

    public class JavadocPackageCheck
    extends AbstractFileSetCheck

    Checks that each Java package has a Javadoc file used for commenting. By default, it only allows a file, but can be configured to allow a package.html file.

    A violation will be reported if both files exist as this is not allowed by the Javadoc tool.

    • Property allowLegacy - Allow legacy package.html file to be used. Type is boolean. Default value is false.
    • Property fileExtensions - Specify the file extensions of the files to process. Type is java.lang.String[]. Default value is .java.

    Parent is

    Violation Message Keys:

    • javadoc.legacyPackageHtml
    • javadoc.packageInfo