You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by mj...@apache.org on 2021/05/24 01:37:16 UTC

[kafka] branch trunk updated: MINOR: update java doc for deprecated methods (#10722)

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

mjsax 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 efb7cda  MINOR: update java doc for deprecated methods (#10722)
efb7cda is described below

commit efb7cda1789b27867a69d3a0131b56123ada0bbe
Author: Luke Chen <sh...@gmail.com>
AuthorDate: Mon May 24 09:33:01 2021 +0800

    MINOR: update java doc for deprecated methods (#10722)
    
    Reviewers: Matthias J. Sax <ma...@confluent.io>
---
 .../src/main/java/org/apache/kafka/streams/kstream/Produced.java  | 8 ++------
 .../src/main/java/org/apache/kafka/tools/VerifiableConsumer.java  | 2 +-
 2 files changed, 3 insertions(+), 7 deletions(-)

diff --git a/streams/src/main/java/org/apache/kafka/streams/kstream/Produced.java b/streams/src/main/java/org/apache/kafka/streams/kstream/Produced.java
index 6c3ed8c..b14c846 100644
--- a/streams/src/main/java/org/apache/kafka/streams/kstream/Produced.java
+++ b/streams/src/main/java/org/apache/kafka/streams/kstream/Produced.java
@@ -26,7 +26,8 @@ import java.util.Objects;
 
 /**
  * This class is used to provide the optional parameters when producing to new topics
- * using {@link KStream#through(String, Produced)} or {@link KStream#to(String, Produced)}.
+ * using {@link KStream#to(String, Produced)}.
+ *
  * @param <K> key type
  * @param <V> value type
  */
@@ -61,7 +62,6 @@ public class Produced<K, V> implements NamedOperation<Produced<K, V>> {
      * @param <K>           key type
      * @param <V>           value type
      * @return  A new {@link Produced} instance configured with keySerde and valueSerde
-     * @see KStream#through(String, Produced)
      * @see KStream#to(String, Produced)
      */
     public static <K, V> Produced<K, V> with(final Serde<K> keySerde,
@@ -80,7 +80,6 @@ public class Produced<K, V> implements NamedOperation<Produced<K, V>> {
      * @param <K>           key type
      * @param <V>           value type
      * @return  A new {@link Produced} instance configured with keySerde, valueSerde, and partitioner
-     * @see KStream#through(String, Produced)
      * @see KStream#to(String, Produced)
      */
     public static <K, V> Produced<K, V> with(final Serde<K> keySerde,
@@ -107,7 +106,6 @@ public class Produced<K, V> implements NamedOperation<Produced<K, V>> {
      * @param <K>           key type
      * @param <V>           value type
      * @return  A new {@link Produced} instance configured with keySerde
-     * @see KStream#through(String, Produced)
      * @see KStream#to(String, Produced)
      */
     public static <K, V> Produced<K, V> keySerde(final Serde<K> keySerde) {
@@ -120,7 +118,6 @@ public class Produced<K, V> implements NamedOperation<Produced<K, V>> {
      * @param <K>           key type
      * @param <V>           value type
      * @return  A new {@link Produced} instance configured with valueSerde
-     * @see KStream#through(String, Produced)
      * @see KStream#to(String, Produced)
      */
     public static <K, V> Produced<K, V> valueSerde(final Serde<V> valueSerde) {
@@ -135,7 +132,6 @@ public class Produced<K, V> implements NamedOperation<Produced<K, V>> {
      * @param <K>           key type
      * @param <V>           value type
      * @return  A new {@link Produced} instance configured with partitioner
-     * @see KStream#through(String, Produced)
      * @see KStream#to(String, Produced)
      */
     public static <K, V> Produced<K, V> streamPartitioner(final StreamPartitioner<? super K, ? super V> partitioner) {
diff --git a/tools/src/main/java/org/apache/kafka/tools/VerifiableConsumer.java b/tools/src/main/java/org/apache/kafka/tools/VerifiableConsumer.java
index 5be76f0..e930580 100644
--- a/tools/src/main/java/org/apache/kafka/tools/VerifiableConsumer.java
+++ b/tools/src/main/java/org/apache/kafka/tools/VerifiableConsumer.java
@@ -73,7 +73,7 @@ import static net.sourceforge.argparse4j.impl.Arguments.storeTrue;
  *     See {@link org.apache.kafka.tools.VerifiableConsumer.PartitionsRevoked}</li>
  * <li>partitions_assigned: outputs the partitions assigned through {@link ConsumerRebalanceListener#onPartitionsAssigned(Collection)}
  *     See {@link org.apache.kafka.tools.VerifiableConsumer.PartitionsAssigned}.</li>
- * <li>records_consumed: contains a summary of records consumed in a single call to {@link KafkaConsumer#poll(long)}.
+ * <li>records_consumed: contains a summary of records consumed in a single call to {@link KafkaConsumer#poll(Duration)}.
  *     See {@link org.apache.kafka.tools.VerifiableConsumer.RecordsConsumed}.</li>
  * <li>record_data: contains the key, value, and offset of an individual consumed record (only included if verbose
  *     output is enabled). See {@link org.apache.kafka.tools.VerifiableConsumer.RecordData}.</li>