Fixing javadoc failure

Signed-off-by: Himshikha Gupta <[email protected]>
opensearch-project · Jun 6, 2024 · 01019da · 01019da
1 parent c8ebbc0
commit 01019da
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 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
@@ -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
@@ -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 {