New javadoc and improvement of existing javadoc

[ker2x]

Friendly greetings !

• fixed a few bogus javadoc (incomplete tags, typo in tags, ...) that were not detected by precommit but detected by inteliJ inspection.
• Improvements of readability on the produced html (aka : a lot of p tags)
• proper html link (there are more to fix)
• new javadocs

Related issue #221

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[ker2x]

Error: 23-10-05T16:38:03.6294364Z ##[error]No space left on device : '/home/runner/runners/2.309.0/_diag/pages/4f78f7b0-f297-4212-9b04-3933f2d7d60d_d04c50ad-a568-5bd7-93c6-7566699f645a_1.log'

[reta]

Error: 23-10-05T16:38:03.6294364Z ##[error]No space left on device : '/home/runner/runners/2.309.0/_diag/pages/4f78f7b0-f297-4212-9b04-3933f2d7d60d_d04c50ad-a568-5bd7-93c6-7566699f645a_1.log'

Yep, working on that, thanks @ker2x

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: UNSTABLE ❕
• TEST FAILURES:

      1 org.opensearch.smoketest.SmokeTestMultiNodeClientYamlTestSuiteIT.test {yaml=pit/10_basic/Delete all}
      1 org.opensearch.search.SearchWeightedRoutingIT.testMultiGetWithNetworkDisruption_FailOpenEnabled

• URL: https://build.ci.opensearch.org/job/gradle-check/27138/
• CommitID: 7db2462
  Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

[reta]

@ker2x could you please rebase one more time, the issue with "no space left" should be gone, thank you

[ker2x]

@ker2x could you please rebase one more time, the issue with "no space left" should be gone, thank you

👍

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/27296/
• CommitID: d113902
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/27300/
• CommitID: d113902
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/27304/
• CommitID: d113902
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[ker2x]

c'mon jenkins, you can do it !

[dblock]

@ker2x one way to cope with these flakes is to actually look at the failures and add a link in the "this is a flaky test" issue, helps avoid flipping tables ;)

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/27310/
• CommitID: d113902
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/27328/
• CommitID: d113902
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/27339/
• CommitID: d113902
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/27424/
• CommitID: c0b42aa
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

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

[ker2x]

yattaaaaaa !
thanks @reta

[reta]

Thanks to you @ker2x for your patience !

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-10064-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c0852f84f0647f78a45e71396d6370a39ba4922f
# Push it to GitHub
git push --set-upstream origin backport/backport-10064-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-10064-to-2.x.