Adding missing Java docs for new Translog implementation (#3936)

Signed-off-by: Sarat Vemulapalli <vemulapallisarat@gmail.com>
opensearch-project · Jul 18, 2022 · 07775ff · 07775ff
1 parent 1020852
commit 07775ff
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 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
@@ -285,9 +285,9 @@ public void ensureCanFlush() {
 
     /**
      * 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 {
@@ -296,9 +296,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 {
@@ -396,8 +396,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
@@ -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;