#161 Update to Checkstyle 8.21

checkstyle · Nov 6, 2019 · 21a5acb · reckart · Nov 6, 2019 · romani
1 parent 6ca1092
commit 21a5acb
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 5 deletions.
diff --git a/net.sf.eclipsecs.checkstyle/.classpath b/net.sf.eclipsecs.checkstyle/.classpath
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
-	<classpathentry exported="true" kind="lib" path="checkstyle-8.20-all.jar" sourcepath="checkstyle-checkstyle-8.20.zip"/>
+	<classpathentry exported="true" kind="lib" path="checkstyle-8.21-all.jar" sourcepath="checkstyle-checkstyle-8.21.zip"/>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>

diff --git a/net.sf.eclipsecs.checkstyle/META-INF/MANIFEST.MF b/net.sf.eclipsecs.checkstyle/META-INF/MANIFEST.MF
@@ -46,5 +46,5 @@ Export-Package: .,
  com.puppycrawl.tools.checkstyle.utils,
  org.apache.commons.beanutils;version="8.20.0"
 Bundle-ClassPath: .,
- checkstyle-8.20-all.jar
+ checkstyle-8.21-all.jar
 Automatic-Module-Name: net.sf.eclipsecs.checkstyle
diff --git a/net.sf.eclipsecs.checkstyle/build.properties b/net.sf.eclipsecs.checkstyle/build.properties
@@ -1,6 +1,6 @@
 bin.includes = META-INF/,\
                .,\
                license/,\
-               checkstyle-8.20-all.jar
+               checkstyle-8.21-all.jar
 jars.compile.order = .
 source.. = metadata/
diff --git a/net.sf.eclipsecs.checkstyle/checkstyle-8.20-all.jar b/net.sf.eclipsecs.checkstyle/checkstyle-8.20-all.jar
diff --git a/net.sf.eclipsecs.checkstyle/checkstyle-8.21-all.jar b/net.sf.eclipsecs.checkstyle/checkstyle-8.21-all.jar
diff --git a/...checkstyle/checkstyle-checkstyle-8.20.zip → ...checkstyle/checkstyle-checkstyle-8.21.zip b/...checkstyle/checkstyle-checkstyle-8.20.zip → ...checkstyle/checkstyle-checkstyle-8.21.zip
diff --git a/...kstyle/metadata/com/puppycrawl/tools/checkstyle/checks/annotation/checkstyle-metadata.xml b/...kstyle/metadata/com/puppycrawl/tools/checkstyle/checks/annotation/checkstyle-metadata.xml
@@ -109,7 +109,6 @@
                     <property-value-option value="VARIABLE_DEF" />
                     <property-value-option value="ANNOTATION_DEF" />
                     <property-value-option value="ANNOTATION_FIELD_DEF" />
-                    <property-value-option value="PARAMETER_DEF" />
                 </enumeration>
             </property-metadata>
             <property-metadata name="allowSamelineSingleParameterlessAnnotation" datatype="Boolean"

diff --git a/...le/metadata/com/puppycrawl/tools/checkstyle/checks/javadoc/checkstyle-metadata.properties b/...le/metadata/com/puppycrawl/tools/checkstyle/checks/javadoc/checkstyle-metadata.properties
@@ -53,6 +53,16 @@ JavadocVariable.name         = Variable Javadoc
 JavadocVariable.scope        = Visibility scope where Javadoc comments are checked.
 JavadocVariable.tokens       = tokens to check
 
+MissingJavadocMethod.name                        = Missing Javadoc Method
+MissingJavadocMethod.desc                        = Checks for missing Javadoc comments for a method or constructor.
+MissingJavadocMethod.minLineCount                = Control the minimal amount of lines in method to allow no documentation.
+MissingJavadocMethod.allowedAnnotations          = Configure the list of annotations that allow missed documentation.
+MissingJavadocMethod.scope                       = Specify the visibility scope where Javadoc comments are checked.
+MissingJavadocMethod.excludeScope                = Specify the visibility scope where Javadoc comments are not checked.
+MissingJavadocMethod.allowMissingPropertyJavadoc = Control whether to allow missing Javadoc on accessor methods for properties (setters and getters).
+MissingJavadocMethod.ignoreMethodNamesRegex      = ignore method whose names are matching specified regex.
+MissingJavadocMethod.tokens                      = tokens to check
+
 MissingJavadocType.name            = Missing Javadoc Type
 MissingJavadocType.desc            = Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions. The scope to verify is specified using the Scope class and defaults to Scope.PUBLIC. To verify another scope, set property scope to one of the Scope constants.
 MissingJavadocType.scope           = specify the visibility scope where Javadoc comments are checked.

diff --git a/...heckstyle/metadata/com/puppycrawl/tools/checkstyle/checks/javadoc/checkstyle-metadata.xml b/...heckstyle/metadata/com/puppycrawl/tools/checkstyle/checks/javadoc/checkstyle-metadata.xml
@@ -77,7 +77,6 @@
             <property-metadata name="ignoreMethodNamesRegex" datatype="Regex">
                 <description>%JavadocMethod.ignoreMethodNamesRegex</description>
             </property-metadata>
-            <message-key key="javadoc.missing" />
             <message-key key="javadoc.classInfo" />
             <message-key key="javadoc.unusedTagGeneral" />
             <message-key key="javadoc.invalidInheritDoc" />
@@ -201,6 +200,40 @@
             <message-key key="javadoc.missing" />
         </rule-metadata>
 
+        <rule-metadata name="%MissingJavadocMethod.name" internal-name="MissingJavadocMethod" parent="TreeWalker">
+            <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck" />
+            <description>%MissingJavadocMethod.desc</description>
+            <property-metadata name="minLineCount" datatype="Integer" default-value="-1">
+                <description>%MissingJavadocMethod.minLineCount</description>
+            </property-metadata>
+            <property-metadata name="allowedAnnotations" datatype="String">
+                <description>%MissingJavadocMethod.allowedAnnotations</description>
+            </property-metadata>
+            <property-metadata name="scope" datatype="SingleSelect" default-value="private">
+                <description>%MissingJavadocMethod.scope</description>
+                <enumeration option-provider="com.puppycrawl.tools.checkstyle.api.Scope" />
+            </property-metadata>
+            <property-metadata name="excludeScope" datatype="SingleSelect" default-value="nothing">
+                <description>%MissingJavadocMethod.excludeScope</description>
+                <enumeration option-provider="com.puppycrawl.tools.checkstyle.api.Scope" />
+            </property-metadata>
+            <property-metadata name="allowMissingPropertyJavadoc" datatype="Boolean" default-value="false">
+                <description>%MissingJavadocMethod.allowMissingPropertyJavadoc</description>
+            </property-metadata>
+            <property-metadata name="ignoreMethodNamesRegex" datatype="Regex">
+                <description>%MissingJavadocMethod.ignoreMethodNamesRegex</description>
+            </property-metadata>
+            <property-metadata name="tokens" datatype="MultiCheck" default-value="METHOD_DEF,CTOR_DEF,ANNOTATION_FIELD_DEF">
+                <description>%MissingJavadocMethod.tokens</description>
+                <enumeration>
+                    <property-value-option value="METHOD_DEF" />
+                    <property-value-option value="CTOR_DEF" />
+                    <property-value-option value="ANNOTATION_FIELD_DEF" />
+                </enumeration>
+            </property-metadata>
+            <message-key key="javadoc.missing" />
+        </rule-metadata>
+
         <rule-metadata name="%MissingJavadocType.name" internal-name="MissingJavadocType" parent="TreeWalker">
             <alternative-name internal-name="com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck" />
             <description>%MissingJavadocType.desc</description>