From 8556282dec28e68e4a00d7da7f68ff59c7c8beb1 Mon Sep 17 00:00:00 2001
From: Dimitrios Efthymiou <efthymiou.dimitrios1@gmail.com>
Date: Mon, 17 Jul 2023 07:03:01 +0100
Subject: [PATCH] HBASE-27906 Fix the javadoc for SyncFutureCache (#5325)

(cherry picked from commit 2c92e6fdce85cb02a4a5c2ecb714fd2efa30835c)
---
 .../regionserver/wal/SyncFutureCache.java     | 20 +++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/SyncFutureCache.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/SyncFutureCache.java
index 27b9f4769eac..f842cc3dabe5 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/SyncFutureCache.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/SyncFutureCache.java
@@ -27,12 +27,20 @@
 
 /**
  * A cache of {@link SyncFuture}s. This class supports two methods
- * {@link SyncFutureCache#getIfPresentOrNew()} and {@link SyncFutureCache#offer(SyncFuture)}. Usage
- * pattern: SyncFuture sf = syncFutureCache.getIfPresentOrNew(); sf.reset(...); // Use the sync
- * future finally: syncFutureCache.offer(sf); Offering the sync future back to the cache makes it
- * eligible for reuse within the same thread context. Cache keyed by the accessing thread instance
- * and automatically invalidated if it remains unused for
- * {@link SyncFutureCache#SYNC_FUTURE_INVALIDATION_TIMEOUT_MINS} minutes.
+ * {@link SyncFutureCache#getIfPresentOrNew()} and {@link SyncFutureCache#offer(SyncFuture)}}.
+ * <p>
+ * Usage pattern:
+ *
+ * <pre>
+ *   SyncFuture sf = syncFutureCache.getIfPresentOrNew();
+ *   sf.reset(...);
+ *   // Use the sync future
+ *   finally: syncFutureCache.offer(sf);
+ * </pre>
+ *
+ * Offering the sync future back to the cache makes it eligible for reuse within the same thread
+ * context. Cache keyed by the accessing thread instance and automatically invalidated if it remains
+ * unused for {@link SyncFutureCache#SYNC_FUTURE_INVALIDATION_TIMEOUT_MINS} minutes.
  */
 @InterfaceAudience.Private
 public final class SyncFutureCache {