fix javadoc

Author: daleiz

client/src/main/java/io/hstream/Consumer.java

@@ -2,5 +2,5 @@
 
 import com.google.common.util.concurrent.Service;
 
-/** The consumer interface of hstream consumer */
+/** The interface for the HStream consumer. */
 public interface Consumer extends Service {}

client/src/main/java/io/hstream/ConsumerBuilder.java

@@ -1,5 +1,6 @@
 package io.hstream;
 
+/** A builder for {@link Consumer}s. */
 public interface ConsumerBuilder {
 
   ConsumerBuilder name(String name);

client/src/main/java/io/hstream/HArray.java

@@ -2,7 +2,7 @@
 
 import com.google.protobuf.ListValue;
 
-/** a data structure like array */
+/** A data structure like array */
 public class HArray {
 
   private ListValue delegate;

client/src/main/java/io/hstream/HArrayBuilder.java

@@ -3,7 +3,7 @@
 import com.google.protobuf.ListValue;
 import com.google.protobuf.util.Values;
 
-/** the {@link HArray} constructor */
+/** A builder for {@link HArray}s. */
 public class HArrayBuilder {
 
   private ListValue.Builder delegate;

client/src/main/java/io/hstream/HRecord.java

@@ -3,7 +3,7 @@
 import com.google.protobuf.ByteString;
 import com.google.protobuf.Struct;
 
-/** the data structure defined by hstream */
+/** A data structure like json object. */
 public class HRecord {
 
   private Struct delegate;

client/src/main/java/io/hstream/HRecordBuilder.java

@@ -3,7 +3,7 @@
 import com.google.protobuf.Struct;
 import com.google.protobuf.util.Values;
 
-/** used to construct a {@link HRecord} */
+/** A builder for {@link io.hstream.HRecord}s. */
 public class HRecordBuilder {
 
   private Struct.Builder structBuilder;

client/src/main/java/io/hstream/HRecordReceiver.java

@@ -1,13 +1,16 @@
 package io.hstream;
 
-/** the interface that user use to process {@link HRecord} received from server */
+/**
+ * This interface can be implemented by users of {@link io.hstream.Consumer} to receive {@link
+ * HRecord}s.
+ */
 public interface HRecordReceiver {
 
   /**
-   * used to consume {@link HRecord} format message.
+   * Used to receive {@link HRecord} format message.
    *
    * @param receivedHRecord {@link ReceivedHRecord} received from producer
-   * @param responder {@link Responder} used to ack producer when received message.
+   * @param responder {@link Responder} used to ack producer when received message
    */
   void processHRecord(ReceivedHRecord receivedHRecord, Responder responder);
 }

client/src/main/java/io/hstream/HStreamClient.java

@@ -3,69 +3,69 @@
 import io.hstream.impl.HStreamClientBuilderImpl;
 import java.util.List;
 
-/** HStreamDB Client. */
+/** A client for the HStreamDB. */
 public interface HStreamClient extends AutoCloseable {
 
-  /** @return {@link HStreamClientBuilder}. */
+  /** @return a {@link HStreamClientBuilder} */
   static HStreamClientBuilder builder() {
     return new HStreamClientBuilderImpl();
   }
 
-  /** @return the {@link ProducerBuilder}. */
+  /** @return a {@link ProducerBuilder} */
   ProducerBuilder newProducer();
 
-  /** @return the {@link ConsumerBuilder}. */
+  /** @return a {@link ConsumerBuilder} */
   ConsumerBuilder newConsumer();
 
-  /** @return the {@link QueryerBuilder}. */
+  /** @return a {@link QueryerBuilder} */
   QueryerBuilder newQueryer();
 
   /**
-   * create a new stream with 3 replicas.
+   * Create a new stream with 3 replicas.
    *
-   * @param stream the name of stream.
+   * @param stream the name of stream
    */
   void createStream(String stream);
 
   /**
-   * create a new stream.
+   * Create a new stream.
    *
-   * @param stream the name of stream.
+   * @param stream the name of stream
    */
   void createStream(String stream, short replicationFactor);
 
   /**
-   * Delete specified stream with streamName.
+   * Delete the specified stream with streamName.
    *
-   * @param stream the name of stream.
+   * @param stream the name of stream
    */
   void deleteStream(String stream);
 
   /**
-   * Return all created {@link Stream}.
+   * List all streams.
    *
-   * @return the list of created streams.
+   * @return a list of {@link Stream}s
    */
   List<Stream> listStreams();
 
   /**
    * Create a new Subscription.
    *
-   * @param subscription {@link Subscription}.
+   * @param subscription {@link Subscription}
    */
   void createSubscription(Subscription subscription);
 
   /**
-   * Return all created {@link Subscription}.
+   * List all subscriptions.
    *
-   * @return the list of created Subscriptions.
+   * @return a list of {@link Subscription}s.
    */
   List<Subscription> listSubscriptions();
 
   /**
-   * Delete specified subscription with subscriptionId.
+   * Delete the specified subscription with subscriptionId.
    *
-   * @param subscriptionId the id of the subscription to be deleted.
+   * @param subscriptionId the id of the subscription to be deleted
    */
   void deleteSubscription(String subscriptionId);
 }

client/src/main/java/io/hstream/HStreamClientBuilder.java

@@ -1,5 +1,6 @@
 package io.hstream;
 
+/** A builder for {@link HStreamClient}s. */
 public interface HStreamClientBuilder {
 
   HStreamClientBuilder serviceUrl(String serviceUrl);

client/src/main/java/io/hstream/Observer.java

@@ -1,6 +1,6 @@
 package io.hstream;
 
-/** Receives notifications from an observable stream of results */
+/** An object used to receive results of a {@link Queryer}. */
 public interface Observer<V> {
 
   /**