From a94f7b1400bb13d6cf6bc965dcae0fa0398fb869 Mon Sep 17 00:00:00 2001
From: anoopsjohn <anoopsamjohn@gmail.com>
Date: Tue, 23 Sep 2014 22:50:55 +0530
Subject: [PATCH] HBASE-12024 Fix javadoc warning.

---
 .../hadoop/hbase/client/ConnectionFactory.java |  1 -
 .../hbase/client/HConnectionManager.java       | 18 +++++++++---------
 .../client/UnmodifyableHTableDescriptor.java   |  6 ------
 .../org/apache/hadoop/hbase/security/User.java |  6 +-----
 4 files changed, 10 insertions(+), 21 deletions(-)

diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/ConnectionFactory.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/ConnectionFactory.java
index 0c054ed6b5b..4a8bdfed54a 100644
--- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/ConnectionFactory.java
+++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/ConnectionFactory.java
@@ -36,7 +36,6 @@ import org.apache.hadoop.hbase.security.UserProvider;
  * From this {@link Connection} {@link Table} implementations are retrieved
  * with {@link Connection#getTable(TableName)}. Example:
  * <pre>
- * {@code
  * Connection connection = ConnectionFactory.createConnection(config);
  * Table table = connection.getTable(TableName.valueOf("table1"));
  * try {
diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HConnectionManager.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HConnectionManager.java
index ef0a69cb333..01d3f36a03a 100644
--- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HConnectionManager.java
+++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HConnectionManager.java
@@ -34,7 +34,6 @@ import org.apache.hadoop.hbase.security.User;
  * From this {@link HConnection} {@link HTableInterface} implementations are retrieved
  * with {@link HConnection#getTable(byte[])}. Example:
  * <pre>
- * {@code
  * HConnection connection = HConnectionManager.createConnection(config);
  * HTableInterface table = connection.getTable(TableName.valueOf("table1"));
  * try {
@@ -43,7 +42,7 @@ import org.apache.hadoop.hbase.security.User;
  *   table.close();
  *   connection.close();
  * }
- * }</pre>
+ * </pre>
  * <p>This class has a static Map of {@link HConnection} instances keyed by
  * {@link HConnectionKey}; A {@link HConnectionKey} is identified by a set of
  * {@link Configuration} properties. Invocations of {@link #getConnection(Configuration)}
@@ -125,7 +124,7 @@ public class HConnectionManager extends ConnectionFactory {
    * calling {@link HConnection#close()} on the returned connection instance.
    *
    * This is the recommended way to create HConnections.
-   * {@code
+   * <pre>
    * HConnection connection = HConnectionManager.createConnection(conf);
    * HTableInterface table = connection.getTable("mytable");
    * try {
@@ -135,6 +134,7 @@ public class HConnectionManager extends ConnectionFactory {
    *   table.close();
    *   connection.close();
    * }
+   * </pre>
    *
    * @param conf configuration
    * @return HConnection object for <code>conf</code>
@@ -152,7 +152,7 @@ public class HConnectionManager extends ConnectionFactory {
    * {@link #getConnection(Configuration)}. The caller is responsible for
    * calling {@link HConnection#close()} on the returned connection instance.
    * This is the recommended way to create HConnections.
-   * {@code
+   * <pre>
    * ExecutorService pool = ...;
    * HConnection connection = HConnectionManager.createConnection(conf, pool);
    * HTableInterface table = connection.getTable("mytable");
@@ -160,7 +160,7 @@ public class HConnectionManager extends ConnectionFactory {
    * ...
    * table.close();
    * connection.close();
-   * }
+   * </pre>
    * @param conf configuration
    * @param pool the thread pool to use for batch operation in HTables used via this HConnection
    * @return HConnection object for <code>conf</code>
@@ -178,7 +178,7 @@ public class HConnectionManager extends ConnectionFactory {
    * {@link #getConnection(Configuration)}. The caller is responsible for
    * calling {@link HConnection#close()} on the returned connection instance.
    * This is the recommended way to create HConnections.
-   * {@code
+   * <pre>
    * ExecutorService pool = ...;
    * HConnection connection = HConnectionManager.createConnection(conf, pool);
    * HTableInterface table = connection.getTable("mytable");
@@ -186,7 +186,7 @@ public class HConnectionManager extends ConnectionFactory {
    * ...
    * table.close();
    * connection.close();
-   * }
+   * </pre>
    * @param conf configuration
    * @param user the user the connection is for
    * @return HConnection object for <code>conf</code>
@@ -204,7 +204,7 @@ public class HConnectionManager extends ConnectionFactory {
    * {@link #getConnection(Configuration)}. The caller is responsible for
    * calling {@link HConnection#close()} on the returned connection instance.
    * This is the recommended way to create HConnections.
-   * {@code
+   * <pre>
    * ExecutorService pool = ...;
    * HConnection connection = HConnectionManager.createConnection(conf, pool);
    * HTableInterface table = connection.getTable("mytable");
@@ -212,7 +212,7 @@ public class HConnectionManager extends ConnectionFactory {
    * ...
    * table.close();
    * connection.close();
-   * }
+   * </pre>
    * @param conf configuration
    * @param pool the thread pool to use for batch operation in HTables used via this HConnection
    * @param user the user the connection is for
diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/UnmodifyableHTableDescriptor.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/UnmodifyableHTableDescriptor.java
index 95c21283c5c..f512712271d 100644
--- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/UnmodifyableHTableDescriptor.java
+++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/UnmodifyableHTableDescriptor.java
@@ -61,7 +61,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
   /**
    * Does NOT add a column family. This object is immutable
    * @param family HColumnDescriptor of familyto add.
-   * @return
    */
   @Override
   public HTableDescriptor addFamily(final HColumnDescriptor family) {
@@ -79,7 +78,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
   }
 
   /**
-   * @return
    * @see org.apache.hadoop.hbase.HTableDescriptor#setReadOnly(boolean)
    */
   @Override
@@ -88,7 +86,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
   }
 
   /**
-   * @return
    * @see org.apache.hadoop.hbase.HTableDescriptor#setValue(byte[], byte[])
    */
   @Override
@@ -97,7 +94,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
   }
 
   /**
-   * @return
    * @see org.apache.hadoop.hbase.HTableDescriptor#setValue(java.lang.String, java.lang.String)
    */
   @Override
@@ -106,7 +102,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
   }
 
   /**
-   * @return
    * @see org.apache.hadoop.hbase.HTableDescriptor#setMaxFileSize(long)
    */
   @Override
@@ -115,7 +110,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
   }
 
   /**
-   * @return
    * @see org.apache.hadoop.hbase.HTableDescriptor#setMemStoreFlushSize(long)
    */
   @Override
diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/security/User.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/security/User.java
index fd12e476f35..df0c3224361 100644
--- a/hbase-common/src/main/java/org/apache/hadoop/hbase/security/User.java
+++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/security/User.java
@@ -24,8 +24,6 @@ import java.lang.reflect.UndeclaredThrowableException;
 import java.security.PrivilegedAction;
 import java.security.PrivilegedExceptionAction;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
 import org.apache.hadoop.classification.InterfaceAudience;
 import org.apache.hadoop.conf.Configuration;
 import org.apache.hadoop.hbase.util.Methods;
@@ -51,8 +49,6 @@ public abstract class User {
   public static final String HBASE_SECURITY_CONF_KEY =
       "hbase.security.authentication";
 
-  private static Log LOG = LogFactory.getLog(User.class);
-
   protected UserGroupInformation ugi;
 
   public UserGroupInformation getUGI() {
@@ -167,7 +163,7 @@ public abstract class User {
   /**
    * Executes the given action as the login user
    * @param action
-   * @return
+   * @return the result of the action
    * @throws IOException
    * @throws InterruptedException
    */