From 328da048ef079e176b0f259dad1f03f39cba3917 Mon Sep 17 00:00:00 2001
From: Peter Alfonsi <petealft@amazon.com>
Date: Fri, 15 Mar 2024 13:21:48 -0700
Subject: [PATCH] javadocs

---
 .../org/opensearch/common/cache/policy/CachedQueryResult.java | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/server/src/main/java/org/opensearch/common/cache/policy/CachedQueryResult.java b/server/src/main/java/org/opensearch/common/cache/policy/CachedQueryResult.java
index fa14fd6d2823f..0a98542a05bb7 100644
--- a/server/src/main/java/org/opensearch/common/cache/policy/CachedQueryResult.java
+++ b/server/src/main/java/org/opensearch/common/cache/policy/CachedQueryResult.java
@@ -59,6 +59,10 @@ public void writeToNoId(StreamOutput out) throws IOException {
         qsr.writeToNoId(out);
     }
 
+    /**
+     * A class containing information needed for all cache policies
+     *  to decide whether to admit a given value.
+     */
     public static class PolicyValues implements Writeable {
         final long tookTimeNanos;
         // More values can be added here as they're needed for future policies