(kafka) branch trunk updated: MINOR: Update on fixing tag description missing in javadoc (#20380)

[chia7712]

This is an automated email from the ASF dual-hosted git repository.

chia7712 pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new 2fd54837f0d MINOR: Update on fixing tag description missing in javadoc 
(#20380)
2fd54837f0d is described below

commit 2fd54837f0d1277d18799b540add1e06e7886f3a
Author: keemsisi <keems...@gmail.com>
AuthorDate: Mon Sep 15 03:13:49 2025 +0100

    MINOR: Update on fixing tag description missing in javadoc (#20380)
    
    * Added tag description to @throws in method javadoc
    * Added explicit throws IndexOffsetOverflowException to method signature
    
    Reviewers: Chia-Ping Tsai <chia7...@gmail.com>
---
 .../org/apache/kafka/storage/internals/log/AbstractIndex.java     | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git 
a/storage/src/main/java/org/apache/kafka/storage/internals/log/AbstractIndex.java
 
b/storage/src/main/java/org/apache/kafka/storage/internals/log/AbstractIndex.java
index b1475884e3a..7e7c3e1cc63 100644
--- 
a/storage/src/main/java/org/apache/kafka/storage/internals/log/AbstractIndex.java
+++ 
b/storage/src/main/java/org/apache/kafka/storage/internals/log/AbstractIndex.java
@@ -301,8 +301,12 @@ public abstract class AbstractIndex implements Closeable {
     }
 
     /**
-     * Get offset relative to base offset of this index
-     * @throws IndexOffsetOverflowException
+     * Gets the offset relative to the {@code baseOffset} of this index.
+     *
+     * @param offset the absolute offset to be converted into a relative 
offset from {@code baseOffset}
+     * @return the relative offset as an {@code int}
+     * @throws IndexOffsetOverflowException if the input offset is lesser than 
the base offset
+     *                                      or if the relative offset exceeds 
{@link Integer#MAX_VALUE}
      */
     public int relativeOffset(long offset) {
         OptionalInt relativeOffset = toRelative(offset);