From c212b9a171ae36e2f8dd0dfb5f5d97bdb6f1a9a7 Mon Sep 17 00:00:00 2001
From: Rick Ossendrijver <rick.ossendrijver@gmail.com>
Date: Mon, 23 Jan 2023 11:16:12 +0100
Subject: [PATCH] Enable Checkstyle's `JavadocStyle` module (#451)

See:
- https://checkstyle.org/config_javadoc.html#JavadocStyle
- https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.html
---
 .../picnic/errorprone/bugpatterns/PrimitiveComparisonTest.java | 2 ++
 pom.xml                                                        | 3 +++
 2 files changed, 5 insertions(+)

diff --git a/error-prone-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/PrimitiveComparisonTest.java b/error-prone-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/PrimitiveComparisonTest.java
index e205fb1c19..3362b95b44 100644
--- a/error-prone-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/PrimitiveComparisonTest.java
+++ b/error-prone-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/PrimitiveComparisonTest.java
@@ -12,6 +12,8 @@
 // XXX: Can we perhaps work-around this by describing the fixes in reverse order?
 final class PrimitiveComparisonTest {
   /**
+   * Tests the identification of {@code byte} comparisons for which boxing can be avoided.
+   *
    * @implNote The logic for {@code char} and {@code short} is exactly analogous to the {@code byte}
    *     case.
    */
diff --git a/pom.xml b/pom.xml
index c0574a1fc3..6143e1d6ce 100644
--- a/pom.xml
+++ b/pom.xml
@@ -710,6 +710,9 @@
                                     <module name="InnerAssignment" />
                                     <module name="InvalidJavadocPosition" />
                                     <module name="JavadocBlockTagLocation" />
+                                    <module name="JavadocStyle">
+                                        <property name="checkEmptyJavadoc" value="true"/>
+                                    </module>
                                     <module name="LocalVariableName" />
                                     <module name="MatchXpath">
                                         <property name="query" value="//BLOCK_COMMENT_BEGIN[./COMMENT_CONTENT[contains(@text, '@author')]]" />