From 7211f133413c770efe51076ec2c8558003220eba Mon Sep 17 00:00:00 2001
From: Shivansh Arora <shivansh.arora@protonmail.com>
Date: Sun, 1 Oct 2023 02:21:24 +0530
Subject: [PATCH] Added javadocs PSA

---
 .../java/org/opensearch/gateway/PrimaryShardAllocator.java     | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/server/src/main/java/org/opensearch/gateway/PrimaryShardAllocator.java b/server/src/main/java/org/opensearch/gateway/PrimaryShardAllocator.java
index a1d53b3e92ff5..7952b8c7aee0d 100644
--- a/server/src/main/java/org/opensearch/gateway/PrimaryShardAllocator.java
+++ b/server/src/main/java/org/opensearch/gateway/PrimaryShardAllocator.java
@@ -510,6 +510,9 @@ static class NodeShardsResult {
         }
     }
 
+    /**
+     * This class encapsulates the result of a call to {@link #buildNodesToAllocate}
+     */
     protected static class NodesToAllocate {
         final List<DecidedNode> yesNodeShards;
         final List<DecidedNode> throttleNodeShards;