HBASE-465 Fix javadoc for all public declarations; some work toward this goal

git-svn-id: https://svn.apache.org/repos/asf/hadoop/hbase/trunk@669340 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/hadoop/hbase/RegionHistorian.java

@@ -82,10 +82,6 @@ public class RegionHistorian implements HConstants {
 
   /**
    * Get the RegionHistorian Singleton instance.
-   * @param c Configuration to use.  Used to create an {@link HTable} homed
-   * on <code>.META.</code>.  The HTable instance is lazily instantiated to 
-   * allow for the getting and storing aside of an Historian instance even
-   * in the case where <code>.META.</code> has not yet deployed.
    * @return The region historian
    */
   public static RegionHistorian getInstance() {
@@ -320,4 +316,4 @@ public class RegionHistorian implements HConstants {
       LOG.debug("Offlined");
     }
   }
-}
+}

src/java/org/apache/hadoop/hbase/client/HConnection.java

@@ -29,7 +29,8 @@ import org.apache.hadoop.hbase.ipc.HMasterInterface;
 import org.apache.hadoop.hbase.ipc.HRegionInterface;
 
 /**
- * 
+ * Cluster connection.
+ * {@link HConnectionManager} manages instances of this class.
  */
 public interface HConnection {
   /**

src/java/org/apache/hadoop/hbase/client/HConnectionManager.java

@@ -56,7 +56,9 @@ import org.apache.hadoop.ipc.RemoteException;
 
 /**
  * A non-instantiable class that manages connections to multiple tables in
- * multiple HBase instances
+ * multiple HBase instances.
+ * 
+ * Used by {@link HTable} and {@link HBaseAdmin}
  */
 public class HConnectionManager implements HConstants {
   /*

src/java/org/apache/hadoop/hbase/client/Scanner.java

@@ -24,7 +24,8 @@ import java.io.IOException;
 import org.apache.hadoop.hbase.io.RowResult;
 
 /**
- * Interface for client-side scanning. 
+ * Interface for client-side scanning.
+ * Go to {@link HTable} to obtain instances.
  */
 public interface Scanner extends Closeable, Iterable<RowResult> {
   /**

src/java/org/apache/hadoop/hbase/client/ScannerCallable.java

@@ -23,13 +23,13 @@ package org.apache.hadoop.hbase.client;
 import java.io.IOException;
 
 import org.apache.hadoop.hbase.HRegionInfo;
-import org.apache.hadoop.hbase.HRegionLocation;
 import org.apache.hadoop.hbase.filter.RowFilterInterface;
 import org.apache.hadoop.hbase.io.RowResult;
 
 
 /**
- * Retryable scanner
+ * Retries scanner operations such as create, next, etc.
+ * Used by {@link Scanner}s made by {@link HTable}.
  */
 public class ScannerCallable extends ServerCallable<RowResult> {
   private long scannerId = -1L;

src/java/org/apache/hadoop/hbase/client/ServerCallable.java

@@ -27,10 +27,8 @@ import org.apache.hadoop.hbase.HRegionLocation;
 import org.apache.hadoop.hbase.ipc.HRegionInterface;
 
 /**
- * Implements Callable, used to define the particular actions you would
- * like to take with retry logic.
+ * Abstract class that implemetns Callable, used by retryable actions.
  * @param <T> the class that the ServerCallable handles
- * 
  */
 public abstract class ServerCallable<T> implements Callable<T> {
   protected final HConnection connection;

src/test/org/apache/hadoop/hbase/TestTable.java

@@ -18,10 +18,9 @@
  * limitations under the License.
  */
 package org.apache.hadoop.hbase;
-import org.apache.hadoop.io.Text;
-
 import java.io.IOException;
 import java.util.concurrent.atomic.AtomicInteger;
+
 import org.apache.hadoop.hbase.client.HBaseAdmin;
 import org.apache.hadoop.hbase.client.HTable;