From b78b25abe0ec32254fb5190b00c6576d1dd0f540 Mon Sep 17 00:00:00 2001
From: "opensearch-trigger-bot[bot]"
 <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com>
Date: Tue, 24 Jan 2023 16:39:35 -0600
Subject: [PATCH] Adding missing Java docs for new Translog implementation
 (#3936) (#5994)

Signed-off-by: Sarat Vemulapalli <vemulapallisarat@gmail.com>
(cherry picked from commit 07775ff69d27b8b58b804bfd93a8d4511c355788)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Signed-off-by: Sarat Vemulapalli <vemulapallisarat@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
---
 .../index/translog/InternalTranslogManager.java      | 12 ++++++------
 .../opensearch/index/translog/TranslogManager.java   |  6 +++---
 2 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/server/src/main/java/org/opensearch/index/translog/InternalTranslogManager.java b/server/src/main/java/org/opensearch/index/translog/InternalTranslogManager.java
index 9ff6640cdff84..c556c46091de5 100644
--- a/server/src/main/java/org/opensearch/index/translog/InternalTranslogManager.java
+++ b/server/src/main/java/org/opensearch/index/translog/InternalTranslogManager.java
@@ -295,9 +295,9 @@ public void setMinSeqNoToKeep(long seqNo) {
 
     /**
      * Reads operations from the translog
-     * @param location
+     * @param location location of translog
      * @return the translog operation
-     * @throws IOException
+     * @throws IOException throws an IO exception
      */
     @Override
     public Translog.Operation readOperation(Translog.Location location) throws IOException {
@@ -306,9 +306,9 @@ public Translog.Operation readOperation(Translog.Location location) throws IOExc
 
     /**
      * Adds an operation to the translog
-     * @param operation
+     * @param operation operation to add to translog
      * @return the location in the translog
-     * @throws IOException
+     * @throws IOException throws an IO exception
      */
     @Override
     public Translog.Location add(Translog.Operation operation) throws IOException {
@@ -407,8 +407,8 @@ public String getTranslogUUID() {
 
     /**
      *
-     * @param localCheckpointOfLastCommit
-     * @param flushThreshold
+     * @param localCheckpointOfLastCommit local checkpoint reference of last commit to translog
+     * @param flushThreshold threshold to flush to translog
      * @return if the translog should be flushed
      */
     public boolean shouldPeriodicallyFlush(long localCheckpointOfLastCommit, long flushThreshold) {
diff --git a/server/src/main/java/org/opensearch/index/translog/TranslogManager.java b/server/src/main/java/org/opensearch/index/translog/TranslogManager.java
index 4d7345b94ca8f..7f1f87d3409e7 100644
--- a/server/src/main/java/org/opensearch/index/translog/TranslogManager.java
+++ b/server/src/main/java/org/opensearch/index/translog/TranslogManager.java
@@ -98,15 +98,15 @@ public interface TranslogManager {
      * Reads operations for the translog
      * @param location the location in the translog
      * @return the translog operation
-     * @throws IOException
+     * @throws IOException throws an IO exception when reading the file fails
      */
     Translog.Operation readOperation(Translog.Location location) throws IOException;
 
     /**
      * Adds an operation to the translog
-     * @param operation
+     * @param operation to add to translog
      * @return the location in the translog
-     * @throws IOException
+     * @throws IOException throws an IO exception if adding an operation fails
      */
     Translog.Location add(Translog.Operation operation) throws IOException;