Class JavadocPackageCheck
java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
,FileSetCheck
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 legacypackage.html
file to be used. Type isboolean
. Default value isfalse
. -
Property
fileExtensions
- Specify the file type extension of files to process. Type isjava.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
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
processFiltered
(File file, FileText fileText) Called to process a file that matches the specified file extensions.void
setAllowLegacy
(boolean allowLegacy) Setter to allow legacypackage.html
file to be used.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
addMessages, beginProcessing, destroy, finishProcessing, fireErrors, getFileContents, getFileExtensions, getMessageDispatcher, getMessages, getTabWidth, init, log, log, process, setFileContents, setFileExtensions, setMessageDispatcher, setTabWidth
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Configurable
configure
Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Contextualizable
contextualize
-
Field Details
-
MSG_LEGACY_PACKAGE_HTML
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
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
Description copied from class:AbstractFileSetCheck
Called to process a file that matches the specified file extensions.- Specified by:
processFiltered
in classAbstractFileSetCheck
- Parameters:
file
- the file to be processedfileText
- the contents of the file.- Throws:
CheckstyleException
- if error condition within Checkstyle occurs.
-
setAllowLegacy
public void setAllowLegacy(boolean allowLegacy) Setter to allow legacypackage.html
file to be used.- Parameters:
allowLegacy
- whether to allow support.
-