Fixed javadoc compilation warnings (api, sql-shell, yarn)

samza-api/src/main/java/org/apache/samza/sql/schema/SqlFieldSchema.java

@@ -51,7 +51,6 @@ private SqlFieldSchema(SamzaSqlFieldType fieldType, SqlFieldSchema elementType,
   /**
    * Create a primitive field schema.
    * @param typeName
-   * @return
    */
   public static SqlFieldSchema createPrimitiveSchema(SamzaSqlFieldType typeName, boolean isNullable,
       boolean isOptional) {
@@ -80,8 +79,7 @@ public boolean isPrimitiveField() {
   }
 
   /**
-   * Get teh Type of the Samza SQL Field.
-   * @return
+   * Get the Type of the Samza SQL Field.
    */
   public SamzaSqlFieldType getFieldType() {
     return fieldType;

samza-api/src/main/java/org/apache/samza/startpoint/StartpointVisitor.java

@@ -28,7 +28,7 @@
 public interface StartpointVisitor<IN, OUT> {
 
   /**
-   * Performs a sequence of operations using the {@link IN} and {@link StartpointSpecific} and returns the result of the execution.
+   * Performs a sequence of operations using IN and {@link StartpointSpecific} and returns the result of the execution.
    * @param input the input metadata about the startpoint.
    * @param startpointSpecific the {@link Startpoint} that represents the specific offset.
    * @return the result of executing the operations defined by the visit method.
@@ -38,7 +38,7 @@ default OUT visit(IN input, StartpointSpecific startpointSpecific) {
   }
 
   /**
-   * Performs a sequence of operations using the {@link IN} and {@link StartpointTimestamp} and returns the result of the execution.
+   * Performs a sequence of operations using IN and {@link StartpointTimestamp} and returns the result of the execution.
    * @param input the input metadata about the startpoint.
    * @param startpointTimestamp the {@link Startpoint} that represents the timestamp.
    * @return the result of executing the operations defined by the visit method.
@@ -48,7 +48,7 @@ default OUT visit(IN input, StartpointTimestamp startpointTimestamp) {
   }
 
   /**
-   * Performs a sequence of operations using the {@link IN} and {@link StartpointOldest} and returns the result of the execution.
+   * Performs a sequence of operations using IN and {@link StartpointOldest} and returns the result of the execution.
    * @param input the input metadata about the startpoint.
    * @param startpointOldest the {@link Startpoint} that represents the earliest offset.
    * @return the result of executing the operations defined by the visit method.
@@ -58,7 +58,7 @@ default OUT visit(IN input, StartpointOldest startpointOldest) {
   }
 
   /**
-   * Performs a sequence of operations using the {@link IN} and {@link StartpointUpcoming} and returns the result of the execution.
+   * Performs a sequence of operations using IN and {@link StartpointUpcoming} and returns the result of the execution.
    * @param input the input metadata about the startpoint.
    * @param startpointUpcoming the {@link Startpoint} that represents the latest offset.
    * @return the result of executing the operations defined by the visit method.

samza-sql-shell/src/main/java/org/apache/samza/sql/client/cli/CliCommand.java

@@ -30,16 +30,16 @@ public class CliCommand {
 
   /**
    * Constructor with empty parameters
-   * @param cmdType: the given {@link CommandType}
+   * @param cmdType the given {@link CommandType}
    */
   public CliCommand(CommandType cmdType) {
     this.commandType = cmdType;
   }
 
   /**
    * Constructor using both {@link CommandType} and parameters
-   * @param cmdType: the given {@link CommandType}
-   * @param parameters: the parameters as single String
+   * @param cmdType the given {@link CommandType}
+   * @param parameters the parameters as single String
    */
   public CliCommand(CommandType cmdType, String parameters) {
     this(cmdType);
@@ -63,7 +63,7 @@ public String getParameters() {
 
   /**
    * Sets the parameters of this command
-   * @param parameters: input parameters
+   * @param parameters input parameters
    */
   public void setParameters(String parameters) {
     this.parameters = parameters;

samza-sql-shell/src/main/java/org/apache/samza/sql/client/exceptions/CommandHandlerException.java

@@ -32,24 +32,24 @@ public CommandHandlerException() {
 
   /**
    * creates instance given error message
-   * @param message: error message
+   * @param message error message
    */
   public CommandHandlerException(String message) {
     super(message);
   }
 
   /**
    * creates instance given error message and {@link Throwable} cause
-   * @param message: error message
-   * @param cause: throwable cause
+   * @param message error message
+   * @param cause throwable cause
    */
   public CommandHandlerException(String message, Throwable cause) {
     super(message, cause);
   }
 
   /**
    * creates instance given {@link Throwable} cause
-   * @param cause: throwable case
+   * @param cause throwable case
    */
   public CommandHandlerException(Throwable cause) {
     super(cause);

samza-sql-shell/src/main/java/org/apache/samza/sql/client/impl/CliCommandHandler.java

@@ -71,10 +71,10 @@ public class CliCommandHandler implements CommandHandler {
 
   /**
    * sets up the member variables
-   * @param shell: the {@link CliShell} which uses this CommandHandler
-   * @param env: the Shell's {@link CliEnvironment}
-   * @param terminal: the {@link Terminal} to print output and messages
-   * @param exeContext: the {@link ExecutionContext}
+   * @param shell the {@link CliShell} which uses this CommandHandler
+   * @param env the Shell's {@link CliEnvironment}
+   * @param terminal the {@link Terminal} to print output and messages
+   * @param exeContext the {@link ExecutionContext}
    */
   public void init(CliShell shell, CliEnvironment env, Terminal terminal, ExecutionContext exeContext) {
     this.env = env;
@@ -88,7 +88,7 @@ public void init(CliShell shell, CliEnvironment env, Terminal terminal, Executio
   /**
    * Attempts to parse the given input string line into a {@link CliCommand} of this
    * handler's {@link org.apache.samza.sql.client.interfaces.CommandType}
-   * @param line: input line string
+   * @param line input line string
    * @return {@link CliCommand} on success, null otherwise
    */
   public CliCommand parseLine(String line) {
@@ -142,7 +142,7 @@ public void printHelpMessage() {
 
   /**
    * Handles the given command
-   * @param command: input {@link CliCommand} to handle
+   * @param command input {@link CliCommand} to handle
    * @return false if command is to quit, or fatal error happened that Shell should not continue running. True o.w.
    * @throws CommandHandlerException if unrecoverable error happened while handling the input {@link CliCommand}
    */

samza-sql-shell/src/main/java/org/apache/samza/sql/client/interfaces/CommandHandler.java

@@ -32,23 +32,23 @@
 public interface CommandHandler {
   /**
    * sets-up the member variables
-   * @param shell: the {@link CliShell} which uses this CommandHandler
-   * @param env: the Shell's {@link CliEnvironment}
-   * @param terminal: the {@link Terminal} to print output and messages
-   * @param exeContext: the {@link ExecutionContext}
+   * @param shell the {@link CliShell} which uses this CommandHandler
+   * @param env the Shell's {@link CliEnvironment}
+   * @param terminal the {@link Terminal} to print output and messages
+   * @param exeContext the {@link ExecutionContext}
    */
   void init(CliShell shell, CliEnvironment env, Terminal terminal, ExecutionContext exeContext);
 
   /**
    * Attempts to parse the given input string line into a {@link CliCommand} of this handler's {@link CommandType}
-   * @param line: input line string
+   * @param line input line string
    * @return {@link CliCommand} on success, null otherwise
    */
   CliCommand parseLine(String line);
 
   /**
    * Handles the given command
-   * @param command: input {@link CliCommand} to handle
+   * @param command input {@link CliCommand} to handle
    * @return false if command is to quit, or fatal error happened that Shell should not continue running. True o.w.
    * @throws CommandHandlerException if unrecoverable error happened
    */

samza-sql-shell/src/main/java/org/apache/samza/sql/client/util/CliUtil.java

@@ -46,7 +46,7 @@ public static StringBuilder appendTo(StringBuilder builder, int toPos, char c) {
 
   /**
    * Trims: leading spaces; trailing spaces and ";"s
-   * @param command: input String to trim
+   * @param command input String to trim
    * @return trimmed String
    */
   public static String trimCommand(String command) {
@@ -68,8 +68,8 @@ public static String trimCommand(String command) {
 
   /**
    * Prints to input {@link PrintWriter} the usage string of the input {@link CliCommand}
-   * @param command: command to get its usage string
-   * @param writer: where to print usage
+   * @param command command to get its usage string
+   * @param writer where to print usage
    */
   public static void printCommandUsage(CliCommand command, PrintWriter writer) {
     writer.println(command.getCommandType().getUsage());

samza-yarn/src/main/java/org/apache/samza/job/yarn/YarnClusterResourceManager.java

@@ -292,8 +292,8 @@ public void releaseResources(SamzaResource resource) {
   /**
    *
    * Requests the launch of a StreamProcessor with the specified ID on the resource
-   * @param resource , the SamzaResource on which to launch the StreamProcessor
-   * @param builder, the builder to build the resource launch command from
+   * @param resource the SamzaResource on which to launch the StreamProcessor
+   * @param builder the builder to build the resource launch command from
    *
    * TODO: Support non-builder methods to launch resources. Maybe, refactor into a ContainerLaunchStrategy interface
    */
@@ -498,8 +498,8 @@ public float getProgress() {
   }
 
   /**
-   * Callback invoked when there is an error in the Yarn client. This delegates the
-   * callback handling to the {@link ClusterResourceManager.Callback} instance.
+   * Callback invoked when there is an error in the Yarn client. This delegates the callback handling to
+   * the {@link org.apache.samza.clustermanager.ClusterResourceManager.Callback} instance.
    *
    */
   @Override