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 package-info.java 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 type extension of files to process. Type is java.lang.String[]. Default value is .java.

To configure the check:

 <module name="JavadocPackage"/>
 

To configure the check to use legacy package.html file when package-info.java file is absent:

 <module name="JavadocPackage">
   <property name="allowLegacy" value="true"/>
 </module>
 

Parent is com.puppycrawl.tools.checkstyle.Checker

Violation Message Keys:

  • javadoc.legacyPackageHtml
  • javadoc.packageInfo
Since:
5.0
  • Field Details

    • MSG_LEGACY_PACKAGE_HTML

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

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

    • JavadocPackageCheck

      public JavadocPackageCheck()
      Creates a new instance.
  • Method Details

    • processFiltered

      protected void processFiltered(File file, FileText fileText) throws CheckstyleException
      Description copied from class: AbstractFileSetCheck
      Called to process a file that matches the specified file extensions.
      Specified by:
      processFiltered in class AbstractFileSetCheck
      Parameters:
      file - the file to be processed
      fileText - the contents of the file.
      Throws:
      CheckstyleException - if error condition within Checkstyle occurs.
    • setAllowLegacy

      public void setAllowLegacy(boolean allowLegacy)
      Setter to allow legacy package.html file to be used.
      Parameters:
      allowLegacy - whether to allow support.