Relax SingleLineJavadoc to avoid fighting the formatter (#1051)

Checkstyle no longer complains about single-line javadoc produced by palantir-java-format.
palantir · Nov 18, 2019 · 5219a41 · 5219a41
1 parent 0c09615
commit 5219a41
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/changelog/@unreleased/pr-1051.v2.yml b/changelog/@unreleased/pr-1051.v2.yml
@@ -0,0 +1,6 @@
+type: fix
+fix:
+  description: Checkstyle no longer complains about single-line javadoc produced by
+    palantir-java-format.
+  links:
+  - https://github.com/palantir/gradle-baseline/pull/1051
diff --git a/gradle-baseline-java-config/resources/checkstyle/checkstyle.xml b/gradle-baseline-java-config/resources/checkstyle/checkstyle.xml
@@ -472,7 +472,6 @@
             <property name="format" value="^_?[a-z][a-zA-Z0-9]+$"/>
             <message key="name.invalidPattern" value="Parameter name ''{0}'' must match pattern ''{1}''."/>
         </module>
-        <module name="SingleLineJavadoc"/> <!-- Java Style Guide: General form -->
         <module name="SummaryJavadocCheck"> <!-- Java Coding Guidelines: Javadoc -->
             <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
         </module>