[GitHub] sijie closed pull request #2681: Fix ConsumerBuilder and PulsarClient document

[GitBox <gi...@apache.org>]

sijie closed pull request #2681: Fix ConsumerBuilder and PulsarClient document
URL: https://github.com/apache/pulsar/pull/2681
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/pulsar-client/src/main/java/org/apache/pulsar/client/api/ConsumerBuilder.java b/pulsar-client/src/main/java/org/apache/pulsar/client/api/ConsumerBuilder.java
index 05d8f14c59..7f5e4488cd 100644
--- a/pulsar-client/src/main/java/org/apache/pulsar/client/api/ConsumerBuilder.java
+++ b/pulsar-client/src/main/java/org/apache/pulsar/client/api/ConsumerBuilder.java
@@ -151,7 +151,6 @@
      *            for unacked messages.
      * @param timeUnit
      *            unit in which the timeout is provided.
-     * @return {@link ConsumerConfiguration}
      */
     ConsumerBuilder<T> ackTimeout(long ackTimeout, TimeUnit timeUnit);
 
@@ -258,9 +257,8 @@
      * The consumer group listener is used for receiving consumer state change in a consumer group for failover
      * subscription. Application can then react to the consumer state changes.
      *
-     * @param listener
+     * @param consumerEventListener
      *            the consumer group listener object
-     * @return consumer configuration
      */
     ConsumerBuilder<T> consumerEventListener(ConsumerEventListener consumerEventListener);
 
@@ -316,7 +314,6 @@
      *
      * @param key
      * @param value
-     * @return
      */
     ConsumerBuilder<T> property(String key, String value);
 
@@ -324,7 +321,6 @@
      * Add all the properties in the provided map
      *
      * @param properties
-     * @return
      */
     ConsumerBuilder<T> properties(Map<String, String> properties);
 
@@ -345,7 +341,6 @@
      * Intercept {@link Consumer}.
      *
      * @param interceptors the list of interceptors to intercept the consumer created by this builder.
-     * @return consumer builder.
      */
     ConsumerBuilder<T> intercept(ConsumerInterceptor<T> ...interceptors);
 
diff --git a/pulsar-client/src/main/java/org/apache/pulsar/client/api/PulsarClient.java b/pulsar-client/src/main/java/org/apache/pulsar/client/api/PulsarClient.java
index ea80bc11e3..eb44188acd 100644
--- a/pulsar-client/src/main/java/org/apache/pulsar/client/api/PulsarClient.java
+++ b/pulsar-client/src/main/java/org/apache/pulsar/client/api/PulsarClient.java
@@ -113,21 +113,21 @@ public static PulsarClient create(String serviceUrl, ClientConfiguration conf) t
     <T> ProducerBuilder<T> newProducer(Schema<T> schema);
 
     /**
-     * Create a producer with default for publishing on a specific topic
+     * Create a consumer with default for subscribing on a specific topic
      *
-     * @return a {@link ProducerBuilder} object to configure and construct the {@link Producer} instance
+     * @return a {@link ConsumerBuilder} object to configure and construct the {@link Consumer} instance
      *
      * @since 2.0.0
      */
     ConsumerBuilder<byte[]> newConsumer();
 
     /**
-     * Create a producer with default for publishing on a specific topic
+     * Create a consumer with default for subscribing on a specific topic
      *
      * @param schema
      *          provide a way to convert between serialized data and domain objects
      *
-     * @return a {@link ProducerBuilder} object to configure and construct the {@link Producer} instance
+     * @return a {@link ConsumerBuilder} object to configure and construct the {@link Consumer} instance
      *
      * @since 2.0.0
      */


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services