From b30610cc66dfbd400cfbfa4c354f87ea11729b87 Mon Sep 17 00:00:00 2001
From: Nicholas Walter Knize <nknize@apache.org>
Date: Fri, 26 May 2023 15:58:01 -0500
Subject: [PATCH] fix missingJavaDoc failures

Signed-off-by: Nicholas Walter Knize <nknize@apache.org>
---
 .../java/org/opensearch/core/action/package-info.java  | 10 ++++++++++
 .../opensearch/core/action/support/package-info.java   | 10 ++++++++++
 .../org/opensearch/core/common/bytes/package-info.java | 10 ++++++++++
 .../opensearch/core/common/compress/package-info.java  | 10 ++++++++++
 .../org/opensearch/core/common/io/StreamsUtil.java     |  5 +++++
 .../org/opensearch/core/common/io/package-info.java    | 10 ++++++++++
 .../opensearch/core/common/settings/package-info.java  | 10 ++++++++++
 .../org/opensearch/core/common/text/package-info.java  | 10 ++++++++++
 .../org/opensearch/core/common/util/package-info.java  | 10 ++++++++++
 .../java/org/opensearch/core/index/package-info.java   | 10 ++++++++++
 .../org/opensearch/core/index/shard/package-info.java  | 10 ++++++++++
 .../opensearch/core/index/snapshots/package-info.java  | 10 ++++++++++
 .../java/org/opensearch/core/rest/package-info.java    | 10 ++++++++++
 13 files changed, 125 insertions(+)
 create mode 100644 libs/core/src/main/java/org/opensearch/core/action/package-info.java
 create mode 100644 libs/core/src/main/java/org/opensearch/core/action/support/package-info.java
 create mode 100644 libs/core/src/main/java/org/opensearch/core/common/bytes/package-info.java
 create mode 100644 libs/core/src/main/java/org/opensearch/core/common/compress/package-info.java
 create mode 100644 libs/core/src/main/java/org/opensearch/core/common/io/package-info.java
 create mode 100644 libs/core/src/main/java/org/opensearch/core/common/settings/package-info.java
 create mode 100644 libs/core/src/main/java/org/opensearch/core/common/text/package-info.java
 create mode 100644 libs/core/src/main/java/org/opensearch/core/common/util/package-info.java
 create mode 100644 libs/core/src/main/java/org/opensearch/core/index/package-info.java
 create mode 100644 libs/core/src/main/java/org/opensearch/core/index/shard/package-info.java
 create mode 100644 libs/core/src/main/java/org/opensearch/core/index/snapshots/package-info.java
 create mode 100644 libs/core/src/main/java/org/opensearch/core/rest/package-info.java

diff --git a/libs/core/src/main/java/org/opensearch/core/action/package-info.java b/libs/core/src/main/java/org/opensearch/core/action/package-info.java
new file mode 100644
index 0000000000000..88cfb3326f8ed
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/action/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Core action module */
+package org.opensearch.core.action;
diff --git a/libs/core/src/main/java/org/opensearch/core/action/support/package-info.java b/libs/core/src/main/java/org/opensearch/core/action/support/package-info.java
new file mode 100644
index 0000000000000..d0a1150d0750d
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/action/support/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Support classes for core action module */
+package org.opensearch.core.action.support;
diff --git a/libs/core/src/main/java/org/opensearch/core/common/bytes/package-info.java b/libs/core/src/main/java/org/opensearch/core/common/bytes/package-info.java
new file mode 100644
index 0000000000000..d197e07f3e5fe
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/common/bytes/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Classes for core Bytes module */
+package org.opensearch.core.common.bytes;
diff --git a/libs/core/src/main/java/org/opensearch/core/common/compress/package-info.java b/libs/core/src/main/java/org/opensearch/core/common/compress/package-info.java
new file mode 100644
index 0000000000000..99459f99c42d8
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/common/compress/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Classes for core compress module */
+package org.opensearch.core.common.compress;
diff --git a/libs/core/src/main/java/org/opensearch/core/common/io/StreamsUtil.java b/libs/core/src/main/java/org/opensearch/core/common/io/StreamsUtil.java
index dccffed7230eb..568e50a54f55c 100644
--- a/libs/core/src/main/java/org/opensearch/core/common/io/StreamsUtil.java
+++ b/libs/core/src/main/java/org/opensearch/core/common/io/StreamsUtil.java
@@ -11,6 +11,11 @@
 import java.io.IOException;
 import java.io.InputStream;
 
+/**
+ * Util library for reading streams
+ *
+ * @opensearch.internal
+ */
 public class StreamsUtil {
     public static int readFully(InputStream reader, byte[] dest, int offset, int len) throws IOException {
         int read = 0;
diff --git a/libs/core/src/main/java/org/opensearch/core/common/io/package-info.java b/libs/core/src/main/java/org/opensearch/core/common/io/package-info.java
new file mode 100644
index 0000000000000..7f5318f53dd35
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/common/io/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Classes for core io module */
+package org.opensearch.core.common.io;
diff --git a/libs/core/src/main/java/org/opensearch/core/common/settings/package-info.java b/libs/core/src/main/java/org/opensearch/core/common/settings/package-info.java
new file mode 100644
index 0000000000000..a2588a4633417
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/common/settings/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Classes for core Settings module */
+package org.opensearch.core.common.settings;
diff --git a/libs/core/src/main/java/org/opensearch/core/common/text/package-info.java b/libs/core/src/main/java/org/opensearch/core/common/text/package-info.java
new file mode 100644
index 0000000000000..02abc5835c84f
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/common/text/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Classes for core text module */
+package org.opensearch.core.common.text;
diff --git a/libs/core/src/main/java/org/opensearch/core/common/util/package-info.java b/libs/core/src/main/java/org/opensearch/core/common/util/package-info.java
new file mode 100644
index 0000000000000..57b1bfece1f90
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/common/util/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Classes for core util module */
+package org.opensearch.core.common.util;
diff --git a/libs/core/src/main/java/org/opensearch/core/index/package-info.java b/libs/core/src/main/java/org/opensearch/core/index/package-info.java
new file mode 100644
index 0000000000000..31ecb88948c9d
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/index/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Classes for core index module */
+package org.opensearch.core.index;
diff --git a/libs/core/src/main/java/org/opensearch/core/index/shard/package-info.java b/libs/core/src/main/java/org/opensearch/core/index/shard/package-info.java
new file mode 100644
index 0000000000000..267d558a5092c
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/index/shard/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Classes for core index/shard module */
+package org.opensearch.core.index.shard;
diff --git a/libs/core/src/main/java/org/opensearch/core/index/snapshots/package-info.java b/libs/core/src/main/java/org/opensearch/core/index/snapshots/package-info.java
new file mode 100644
index 0000000000000..b3bb62e40b7d0
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/index/snapshots/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Classes for core snapshots module */
+package org.opensearch.core.index.snapshots;
diff --git a/libs/core/src/main/java/org/opensearch/core/rest/package-info.java b/libs/core/src/main/java/org/opensearch/core/rest/package-info.java
new file mode 100644
index 0000000000000..8c99d38e5f003
--- /dev/null
+++ b/libs/core/src/main/java/org/opensearch/core/rest/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Classes for core REST module */
+package org.opensearch.core.rest;