Skip to content

Commit 3e32d9a

Browse files
authored
MINOR: add missing javadoc to Metadata.java (#22106)
Fix typo and add missing description to `@params` tags in `Metadata.java` Reviewers: Andrew Schofield <aschofield@confluent.io>
1 parent 28402a3 commit 3e32d9a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

clients/src/main/java/org/apache/kafka/clients/Metadata.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -220,13 +220,13 @@ public synchronized int requestUpdateForNewTopics() {
220220
}
221221

222222
/**
223-
* Request an update for the partition metadata iff we have seen a newer leader epoch. This is called by the client
223+
* Request an update for the partition metadata if and only if we have seen a newer leader epoch. This is called by the client
224224
* any time it handles a response from the broker that includes leader epoch, except for update via Metadata RPC which
225225
* follows a different code path ({@link #update}).
226226
*
227-
* @param topicPartition
228-
* @param leaderEpoch
229-
* @return true if we updated the last seen epoch, false otherwise
227+
* @param topicPartition The partition for which to update the last seen leader epoch.
228+
* @param leaderEpoch The leader epoch received from the broker.
229+
* @return {@code true} if we updated the last seen epoch, {@code false} otherwise.
230230
*/
231231
public synchronized boolean updateLastSeenEpochIfNewer(TopicPartition topicPartition, int leaderEpoch) {
232232
Objects.requireNonNull(topicPartition, "TopicPartition cannot be null");

0 commit comments

Comments
 (0)