From a78e7a43b73fc87c4d3b0023e7e3a360436fa566 Mon Sep 17 00:00:00 2001 From: atheendre130505 Date: Sun, 26 Oct 2025 22:19:25 +0530 Subject: [PATCH] Fix incomplete Javadoc comments in storage module - Add missing @return description in ProducerManager.publishMessage() - Add missing @return description in RemoteLogMetadataCache.listAllRemoteLogSegments() - Add missing @throws description in LogDirFailureChannel.takeNextOfflineLogDir() All Javadoc tags now have proper descriptions following Apache Kafka documentation standards. --- .../server/log/remote/metadata/storage/ProducerManager.java | 2 +- .../log/remote/metadata/storage/RemoteLogMetadataCache.java | 2 +- .../kafka/storage/internals/log/LogDirFailureChannel.java | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/storage/src/main/java/org/apache/kafka/server/log/remote/metadata/storage/ProducerManager.java b/storage/src/main/java/org/apache/kafka/server/log/remote/metadata/storage/ProducerManager.java index dc2c0d20abcb5..a09518a168020 100644 --- a/storage/src/main/java/org/apache/kafka/server/log/remote/metadata/storage/ProducerManager.java +++ b/storage/src/main/java/org/apache/kafka/server/log/remote/metadata/storage/ProducerManager.java @@ -57,7 +57,7 @@ public ProducerManager(TopicBasedRemoteLogMetadataManagerConfig rlmmConfig, * is considered complete. * * @param remoteLogMetadata RemoteLogMetadata to be published - * @return + * @return CompletableFuture that completes with RecordMetadata when the message is successfully published */ CompletableFuture publishMessage(RemoteLogMetadata remoteLogMetadata) { CompletableFuture future = new CompletableFuture<>(); diff --git a/storage/src/main/java/org/apache/kafka/server/log/remote/metadata/storage/RemoteLogMetadataCache.java b/storage/src/main/java/org/apache/kafka/server/log/remote/metadata/storage/RemoteLogMetadataCache.java index 4316f7345beb2..65a78ad7dde33 100644 --- a/storage/src/main/java/org/apache/kafka/server/log/remote/metadata/storage/RemoteLogMetadataCache.java +++ b/storage/src/main/java/org/apache/kafka/server/log/remote/metadata/storage/RemoteLogMetadataCache.java @@ -276,7 +276,7 @@ private static long highestOffsetForEpoch(Integer leaderEpoch, RemoteLogSegmentM /** * Returns all the segments stored in this cache. * - * @return + * @return Iterator over all RemoteLogSegmentMetadata instances in the cache */ Iterator listAllRemoteLogSegments() { // Return all the segments including unreferenced metadata. diff --git a/storage/src/main/java/org/apache/kafka/storage/internals/log/LogDirFailureChannel.java b/storage/src/main/java/org/apache/kafka/storage/internals/log/LogDirFailureChannel.java index 21c5dc01bb67c..ed9c0b7de2d64 100644 --- a/storage/src/main/java/org/apache/kafka/storage/internals/log/LogDirFailureChannel.java +++ b/storage/src/main/java/org/apache/kafka/storage/internals/log/LogDirFailureChannel.java @@ -69,7 +69,7 @@ public void maybeAddOfflineLogDir(String logDir, String msg, IOException e) { * The method will wait if necessary until a new offline log directory becomes available * * @return The next offline log dir. - * @throws InterruptedException + * @throws InterruptedException if the current thread is interrupted while waiting */ public String takeNextOfflineLogDir() throws InterruptedException { return offlineLogDirQueue.take();