Adding missing Java docs for new Translog implementation

[saratvemulapalli]

Signed-off-by: Sarat Vemulapalli [email protected]

Description

Missing Java docs is causing failures on my local builds.
Was trying to debug: #3935 (comment)

Seeing failures: Not sure why CI is not seeing this problem. Will take it as a follow up.

./gradlew ':server:test' --tests "org.opensearch.common.time.DateUtilsTests.testTimezoneIds" 

> Configure project :qa:os
Cannot add task 'destructiveDistroTest.docker' as a task with that name already exists.
=======================================
OpenSearch Build Hamster says Hello!
  Gradle Version        : 7.5
  OS Info               : Linux 5.4.0-1037-aws (amd64)
  JDK Version           : 14 (Private Build JDK)
  JAVA_HOME             : /usr/lib/jvm/java-14-openjdk-amd64
  Random Testing Seed   : BB94918BD913A13B
  In FIPS 140 mode      : false
=======================================

> Task :server:compileJava
/home/ubuntu/joda-opensearch/server/src/main/java/org/opensearch/index/translog/TranslogManager.java:101: warning: no description for @throws
     * @throws IOException
       ^
/home/ubuntu/joda-opensearch/server/src/main/java/org/opensearch/index/translog/TranslogManager.java:107: warning: no description for @param
     * @param operation
       ^
/home/ubuntu/joda-opensearch/server/src/main/java/org/opensearch/index/translog/TranslogManager.java:109: warning: no description for @throws
     * @throws IOException
       ^
/home/ubuntu/joda-opensearch/server/src/main/java/org/opensearch/index/translog/InternalTranslogManager.java:288: warning: no description for @param
     * @param location
       ^
/home/ubuntu/joda-opensearch/server/src/main/java/org/opensearch/index/translog/InternalTranslogManager.java:290: warning: no description for @throws
     * @throws IOException
       ^
/home/ubuntu/joda-opensearch/server/src/main/java/org/opensearch/index/translog/InternalTranslogManager.java:299: warning: no description for @param
     * @param operation
       ^
/home/ubuntu/joda-opensearch/server/src/main/java/org/opensearch/index/translog/InternalTranslogManager.java:301: warning: no description for @throws
     * @throws IOException
       ^
/home/ubuntu/joda-opensearch/server/src/main/java/org/opensearch/index/translog/InternalTranslogManager.java:399: warning: no description for @param
     * @param localCheckpointOfLastCommit
       ^
/home/ubuntu/joda-opensearch/server/src/main/java/org/opensearch/index/translog/InternalTranslogManager.java:400: warning: no description for @param
     * @param flushThreshold
       ^
error: warnings found and -Werror specified
Note: Some input files use or override a deprecated API.
Note: Recompile with -Xlint:deprecation for details.
Note: Some input files use unchecked or unsafe operations.
Note: Recompile with -Xlint:unchecked for details.
1 error
9 warnings

> Task :server:compileJava FAILED

FAILURE: Build failed with an exception.

Issues Resolved

Closes #3892

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: UNSTABLE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/743/
• CommitID: a2da54a

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/744/
• CommitID: a2da54a

[saratvemulapalli]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/744/
• CommitID: a2da54a

#3872

[tlfeng]

Thank you @saratvemulapalli for adding the missing javadoc, and there is an open issue: #3892 😁

[owaiskazi19]

Thanks for the changes @saratvemulapalli!

[saratvemulapalli]

Thank you @saratvemulapalli for adding the missing javadoc, and there is an open issue: #3892 😁

Lol I didnt know an issue existed. Thanks @tlfeng !

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: SUCCESS ✅
• URL: https://build.ci.opensearch.org/job/gradle-check/747/
• CommitID: a2da54a