Fixing javadocs

Author: akshaisarma

src/main/java/com/yahoo/bullet/pubsub/PubSub.java

@@ -30,7 +30,7 @@ public enum Context {
     /**
      * Instantiate a PubSub using parameters from {@link PubSubConfig}.
      *
-     * @param config the {@link PubSubConfig} containing all required PubSub parameters.
+     * @param config The {@link PubSubConfig} containing all required PubSub parameters.
      */
     public PubSub(PubSubConfig config) {
         context = Context.valueOf(config.get(PubSubConfig.CONTEXT_NAME).toString());
@@ -49,15 +49,15 @@ public PubSub(PubSubConfig config) {
      * (See {@link PubSub#context}) split as evenly as possible among them.
      *
      * @param n The number of Publishers requested.
-     * @return List of n Publishers wired as required.
+     * @return The {@link List} of n Publishers wired as required.
      */
     public abstract List<Publisher> getPublishers(int n);
 
     /**
      * Get a {@link Subscriber} instance wired to read from all allocated partitions in the appropriate queue (See
      * {@link PubSub#context}).
      *
-     * @return {@link Subscriber} wired as required.
+     * @return The {@link Subscriber} wired as required.
      */
     public abstract Subscriber getSubscriber();
 
@@ -66,13 +66,14 @@ public PubSub(PubSubConfig config) {
      * (See {@link PubSub#context}) split as evenly as possible among them.
      *
      * @param n The number of Subscribers requested.
-     * @return List of n Subscribers wired as required.
+     * @return The {@link List} of n Subscribers wired as required.
      */
     public abstract List<Subscriber> getSubscribers(int n);
 
     /**
      * Create a PubSub instance using the class specified in the config file.
-     * @param config {@link PubSubConfig} containing the class name and PubSub settings.
+     *
+     * @param config The {@link PubSubConfig} containing the class name and PubSub settings.
      * @return an instance of specified class initialized with settings from the input file and defaults.
      * @throws PubSubException if PubSub creation fails.
      */

src/main/java/com/yahoo/bullet/pubsub/PubSubException.java

@@ -4,7 +4,7 @@ public class PubSubException extends Exception {
     /**
      * Exception to be thrown if there is an error in {@link PubSub}, {@link Publisher} or {@link Subscriber}.
      *
-     * @param message error message to be associated with the PubSubException.
+     * @param message The error message to be associated with the PubSubException.
      */
     public PubSubException(String message) {
         super(message);

src/main/java/com/yahoo/bullet/pubsub/PubSubMessage.java

@@ -19,8 +19,8 @@ public class PubSubMessage implements Serializable {
     /**
      * Constructor for a message having only content.
      *
-     * @param id is the ID associated with the message.
-     * @param content is the content of the message.
+     * @param id The ID associated with the message.
+     * @param content The content of the message.
      */
     public PubSubMessage(String id, String content) {
         this(id, content, -1, new Metadata());
@@ -29,9 +29,9 @@ public PubSubMessage(String id, String content) {
     /**
      * Constructor for a message having content and a sequence number.
      *
-     * @param id is the ID associated with the message.
-     * @param content is the content of the message.
-     * @param sequence is the sequence number of the message.
+     * @param id The ID associated with the message.
+     * @param content The content of the message.
+     * @param sequence The sequence number of the message.
      */
     public PubSubMessage(String id, String content, int sequence) {
         this(id, content, sequence, new Metadata());
@@ -40,9 +40,9 @@ public PubSubMessage(String id, String content, int sequence) {
     /**
      * Constructor for a PubSubMessage having content and Metadata.
      *
-     * @param id is the ID associated with the message.
-     * @param content is the content of the message.
-     * @param metadata is the {@link Metadata} associated with the message.
+     * @param id The ID associated with the message.
+     * @param content The content of the message.
+     * @param metadata The {@link Metadata} associated with the message.
      */
     public PubSubMessage(String id, String content, Metadata metadata) {
         this(id, content, -1, metadata);
@@ -51,10 +51,10 @@ public PubSubMessage(String id, String content, Metadata metadata) {
     /**
      * Constructor for a message having content, a {@link Metadata.Signal} and a sequence number.
      *
-     * @param id is the ID associated with the message.
-     * @param content is the content of the message.
-     * @param sequence is the sequence number of the message.
-     * @param signal is the Metadata.Signal of the message.
+     * @param id The ID associated with the message.
+     * @param content The content of the message.
+     * @param sequence The sequence number of the message.
+     * @param signal The Metadata.Signal of the message.
      */
     public PubSubMessage(String id, String content, int sequence, Signal signal) {
         this(id, content, sequence, new Metadata(signal, null));
@@ -63,10 +63,10 @@ public PubSubMessage(String id, String content, int sequence, Signal signal) {
     /**
      * Constructor for a PubSubMessage having content, Metadata and a sequence number.
      *
-     * @param id is the ID associated with the message.
-     * @param content is the content of the message.
-     * @param sequence is the sequence number associated with the message.
-     * @param metadata is the {@link Metadata} associated with the message.
+     * @param id The ID associated with the message.
+     * @param content The content of the message.
+     * @param sequence The sequence number associated with the message.
+     * @param metadata The {@link Metadata} associated with the message.
      */
     public PubSubMessage(String id, String content, int sequence, Metadata metadata) {
         this.id = id;

src/main/java/com/yahoo/bullet/pubsub/Publisher.java

@@ -4,7 +4,7 @@ public interface Publisher {
     /**
      * Sends a {@link PubSubMessage}. Messages with the same ID should be received in order.
      *
-     * @param message the {@link PubSubMessage} to be sent.
+     * @param message The {@link PubSubMessage} to be sent.
      * @throws PubSubException if the messaging system throws an error.
      */
     void send(PubSubMessage message) throws PubSubException;

src/main/java/com/yahoo/bullet/pubsub/Subscriber.java

@@ -22,15 +22,15 @@ public interface Subscriber {
      *  1. Ack all received messages.
      *  2. Commit current read offset to persistent/fault tolerant storage.
      *
-     *  @param id the ID of the message to be marked as committed.
-     *  @param sequence the sequence number of the message to be committed.
+     * @param id The ID of the message to be marked as committed.
+     * @param sequence The sequence number of the message to be committed.
      */
     void commit(String id, int sequence);
 
     /**
      * Convenience method to commit a message that doesn't contain a sequence number.
      *
-     * @param id is the ID of the message to be marked as committed.
+     * @param id The ID of the message to be marked as committed.
      */
     default void commit(String id) {
         commit(id, -1);
@@ -39,14 +39,15 @@ default void commit(String id) {
     /**
      * Marks the processing of the {@link PubSubMessage} with the given id as failed.
      *
-     * @param id the ID of the PubSubMessage to mark as a processing failure.
+     * @param id The ID of the PubSubMessage to mark as a processing failure.
+     * @param sequence The sequence number of the PubSubMessage to mark as a processing failure.
      */
     void fail(String id, int sequence);
 
     /**
      * Convenience method to fail a message that doesn't contain a sequence number.
      *
-     * @param id is the ID of the message to be marked as a processing failure.
+     * @param id The ID of the message to be marked as a processing failure.
      */
     default void fail(String id) {
         fail(id, -1);