From e7b9e65fc3b06e784008a4dd14a8ba305ac30374 Mon Sep 17 00:00:00 2001
From: Tanguy Leroux <tlrx.dev@gmail.com>
Date: Mon, 21 Nov 2016 12:36:44 +0100
Subject: [PATCH] Add checkstyle rule to forbid empty javadoc comments (#20881)

This commit adds a RegexpMultiline check to checkstyle that yells when an empty Javadoc comment is found in Java files.

Related #20871
---
 buildSrc/src/main/resources/checkstyle.xml                 | 7 +++++++
 .../org/elasticsearch/search/nested/SimpleNestedIT.java    | 3 ---
 .../test/rest/yaml/ESClientYamlSuiteTestCase.java          | 2 +-
 3 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/buildSrc/src/main/resources/checkstyle.xml b/buildSrc/src/main/resources/checkstyle.xml
index 706ef46ffa1..891a85d50a9 100644
--- a/buildSrc/src/main/resources/checkstyle.xml
+++ b/buildSrc/src/main/resources/checkstyle.xml
@@ -10,6 +10,13 @@
     <property name="file" value="${suppressions}" />
   </module>
 
+  <!-- Checks Java files and forbids empty Javadoc comments -->
+  <module name="RegexpMultiline">
+    <property name="format" value="\/\*[\s\*]*\*\/"/>
+    <property name="fileExtensions" value="java"/>
+    <property name="message" value="Empty javadoc comments are forbidden"/>
+  </module>
+
   <module name="TreeWalker">
     <!-- Its our official line length! See checkstyle_suppressions.xml for the files that don't pass this. For now we
       suppress the check there but enforce it everywhere else. This prevents the list from getting longer even if it is
diff --git a/core/src/test/java/org/elasticsearch/search/nested/SimpleNestedIT.java b/core/src/test/java/org/elasticsearch/search/nested/SimpleNestedIT.java
index ec18e528a40..442274d71e7 100644
--- a/core/src/test/java/org/elasticsearch/search/nested/SimpleNestedIT.java
+++ b/core/src/test/java/org/elasticsearch/search/nested/SimpleNestedIT.java
@@ -1053,8 +1053,6 @@ public class SimpleNestedIT extends ESIntegTestCase {
         assertThat(clusterStatsResponse.getIndicesStats().getSegments().getBitsetMemoryInBytes(), equalTo(0L));
     }
 
-    /**
-     */
     private void assertDocumentCount(String index, long numdocs) {
         IndicesStatsResponse stats = admin().indices().prepareStats(index).clear().setDocs(true).get();
         assertNoFailures(stats);
@@ -1062,5 +1060,4 @@ public class SimpleNestedIT extends ESIntegTestCase {
 
     }
 
-
 }
diff --git a/test/framework/src/main/java/org/elasticsearch/test/rest/yaml/ESClientYamlSuiteTestCase.java b/test/framework/src/main/java/org/elasticsearch/test/rest/yaml/ESClientYamlSuiteTestCase.java
index cb46c278c2b..d44ce71decb 100644
--- a/test/framework/src/main/java/org/elasticsearch/test/rest/yaml/ESClientYamlSuiteTestCase.java
+++ b/test/framework/src/main/java/org/elasticsearch/test/rest/yaml/ESClientYamlSuiteTestCase.java
@@ -68,7 +68,7 @@ public abstract class ESClientYamlSuiteTestCase extends ESRestTestCase {
     public static final String REST_TESTS_SUITE = "tests.rest.suite";
     /**
      * Property that allows to blacklist some of the REST tests based on a comma separated list of globs
-     * e.g. -Dtests.rest.blacklist=get/10_basic/*
+     * e.g. "-Dtests.rest.blacklist=get/10_basic/*"
      */
     public static final String REST_TESTS_BLACKLIST = "tests.rest.blacklist";
     /**