(kafka) branch trunk updated: MINOR: Improve javadoc for ListShareGroupOffsetsResult (#18650)

[sc...@apache.org]

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

schofielaj 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 7cbfd22bdef MINOR: Improve javadoc for ListShareGroupOffsetsResult (#18650)
7cbfd22bdef is described below

commit 7cbfd22bdef9c45c1f9bd20cbf741bf262e3cafb
Author: Andrew Schofield <as...@confluent.io>
AuthorDate: Tue Jan 21 13:56:40 2025 +0000

    MINOR: Improve javadoc for ListShareGroupOffsetsResult (#18650)
    
    Reviewers: Lianet Magrans <lm...@confluent.io>, PoAn Yang <pa...@apache.org>, Apoorv Mittal <ap...@gmail.com>
---
 .../apache/kafka/clients/admin/ListShareGroupOffsetsResult.java   | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/clients/src/main/java/org/apache/kafka/clients/admin/ListShareGroupOffsetsResult.java b/clients/src/main/java/org/apache/kafka/clients/admin/ListShareGroupOffsetsResult.java
index cdcd4075af0..5ec11fad642 100644
--- a/clients/src/main/java/org/apache/kafka/clients/admin/ListShareGroupOffsetsResult.java
+++ b/clients/src/main/java/org/apache/kafka/clients/admin/ListShareGroupOffsetsResult.java
@@ -45,7 +45,7 @@ public class ListShareGroupOffsetsResult {
     /**
      * Return the future when the requests for all groups succeed.
      *
-     * @return - Future which yields all Map&lt;String, Map&lt;TopicPartition, Long&gt;&gt; objects, if requests for all the groups succeed.
+     * @return Future which yields all {@code Map<String, Map<TopicPartition, Long>>} objects, if requests for all the groups succeed.
      */
     public KafkaFuture<Map<String, Map<TopicPartition, Long>>> all() {
         return KafkaFuture.allOf(futures.values().toArray(new KafkaFuture[0])).thenApply(
@@ -65,8 +65,10 @@ public class ListShareGroupOffsetsResult {
     }
 
     /**
-     * @param groupId - The groupId for which the Map&lt;TopicPartition, Long&gt; is needed
-     * @return - Future which yields a map of topic partitions to offsets for the specified group.
+     * Return a future which yields a map of topic partitions to offsets for the specified group.
+     *
+     * @param groupId The group ID.
+     * @return Future which yields a map of topic partitions to offsets for the specified group.
      */
     public KafkaFuture<Map<TopicPartition, Long>> partitionsToOffset(String groupId) {
         if (!futures.containsKey(groupId)) {