From 01019da4ed4b736eac2ff1802a056b82df9ad385 Mon Sep 17 00:00:00 2001 From: Himshikha Gupta Date: Thu, 6 Jun 2024 12:13:06 +0530 Subject: [PATCH] Fixing javadoc failure Signed-off-by: Himshikha Gupta --- .../remote/routingtable/IndexRoutingTableHeader.java | 6 +++--- .../remote/routingtable/RemoteIndexRoutingTable.java | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/server/src/main/java/org/opensearch/gateway/remote/routingtable/IndexRoutingTableHeader.java b/server/src/main/java/org/opensearch/gateway/remote/routingtable/IndexRoutingTableHeader.java index 059b385394cb5..5baea6adba0c7 100644 --- a/server/src/main/java/org/opensearch/gateway/remote/routingtable/IndexRoutingTableHeader.java +++ b/server/src/main/java/org/opensearch/gateway/remote/routingtable/IndexRoutingTableHeader.java @@ -38,8 +38,8 @@ public IndexRoutingTableHeader(String indexName) { /** * Reads the contents on the stream into the corresponding {@link IndexRoutingTableHeader} * - * @param in - * @throws IOException + * @param in streamInput + * @throws IOException exception thrown on failing to read from stream. */ public IndexRoutingTableHeader(StreamInput in) throws IOException { try { @@ -62,7 +62,7 @@ private void readHeaderVersion(final StreamInput in) throws IOException { * Write the IndexRoutingTable to given stream. * * @param out stream to write - * @throws IOException + * @throws IOException exception thrown on failing to write to stream. */ public void writeTo(StreamOutput out) throws IOException { try { diff --git a/server/src/main/java/org/opensearch/gateway/remote/routingtable/RemoteIndexRoutingTable.java b/server/src/main/java/org/opensearch/gateway/remote/routingtable/RemoteIndexRoutingTable.java index c584e8400939f..17c55190da07f 100644 --- a/server/src/main/java/org/opensearch/gateway/remote/routingtable/RemoteIndexRoutingTable.java +++ b/server/src/main/java/org/opensearch/gateway/remote/routingtable/RemoteIndexRoutingTable.java @@ -34,9 +34,9 @@ public RemoteIndexRoutingTable(IndexRoutingTable indexRoutingTable) { /** * Reads data from inputStream and creates RemoteIndexRoutingTable object with the {@link IndexRoutingTable} - * @param inputStream - * @param index - * @throws IOException + * @param inputStream input stream with index routing data + * @param index index for the current routing data + * @throws IOException exception thrown on failing to read from stream. */ public RemoteIndexRoutingTable(InputStream inputStream, Index index) throws IOException { try { @@ -65,8 +65,8 @@ public IndexRoutingTable getIndexRoutingTable() { /** * Writes {@link IndexRoutingTable} to the given stream - * @param streamOutput - * @throws IOException + * @param streamOutput output stream to write + * @throws IOException exception thrown on failing to write to stream. */ @Override public void writeTo(StreamOutput streamOutput) throws IOException {