javadoc warnings not causing failures

Signed-off-by: Andriy Redko <[email protected]>
opensearch-project · Jan 25, 2023 · d2d1c21 · d2d1c21
1 parent 715ff72
commit d2d1c21
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/build.gradle b/build.gradle
@@ -315,6 +315,7 @@ allprojects {
     // see https://discuss.gradle.org/t/add-custom-javadoc-option-that-does-not-take-an-argument/5959
     javadoc.options.encoding = 'UTF8'
     javadoc.options.addStringOption('Xdoclint:all,-missing', '-quiet')
+    javadoc.options.addStringOption('Xwerror', '-quiet')
     javadoc.options.tags = ["opensearch.internal", "opensearch.api", "opensearch.experimental"]
     javadoc.options.addStringOption("-release", targetCompatibility.majorVersion)
   }

diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShard.java b/server/src/main/java/org/opensearch/index/shard/IndexShard.java
@@ -1689,9 +1689,9 @@ static Engine.Searcher wrapSearcher(
      * Used with segment replication during relocation handoff, this method updates current read only engine to global
      * checkpoint followed by changing to writeable engine
      *
-     * @throws IOException
-     * @throws InterruptedException
-     * @throws TimeoutException
+     * @throws IOException if communication failed
+     * @throws InterruptedException if calling thread is interrupted
+     * @throws TimeoutException if timed out waiting for in-flight operations to finish
      *
      * @opensearch.internal
      */