HBASE-1499 Fix javadoc warnings

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

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

@@ -26,7 +26,6 @@ import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
-import org.apache.hadoop.hbase.client.Get;
 import org.apache.hadoop.hbase.io.ImmutableBytesWritable;
 import org.apache.hadoop.hbase.io.hfile.Compression;
 import org.apache.hadoop.hbase.io.hfile.HFile;
@@ -61,7 +60,7 @@ public class HColumnDescriptor implements ISerializable, WritableComparable<HCol
    * The type of compression.
    * @see org.apache.hadoop.io.SequenceFile.Writer
    * @deprecated Compression now means which compression library
-   * rather than 'what' to cmopress.  See {@link Compression.Algorithm}
+   * rather than 'what' to compress.
    */
   @Deprecated
   public static enum CompressionType {
@@ -194,7 +193,6 @@ public class HColumnDescriptor implements ISerializable, WritableComparable<HCol
    * @param inMemory If true, column data should be kept in an HRegionServer's
    * cache
    * @param blockCacheEnabled If true, MapFile blocks should be cached
-   * @param maxValueLength Restrict values to &lt;= this value
    * @param timeToLive Time-to-live of cell contents, in seconds
    * (use HConstants.FOREVER for unlimited TTL)
    * @param bloomFilter Enable the specified bloom filter for this column

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

@@ -123,10 +123,12 @@ public class KeyValue implements Writable, HeapSize {
   
   /**
    * Get the appropriate row comparator for the specified table.
+   * 
    * Hopefully we can get rid of this, I added this here because it's replacing
    * something in HSK.  We should move completely off of that.
-   * @param tableName
-   * @return
+   * 
+   * @param tableName  The table name.
+   * @return The comparator.
    */
   public static RawComparator<byte []> getRowComparator(byte [] tableName) {
     if(Bytes.equals(HTableDescriptor.ROOT_TABLEDESC.getName(),tableName)) {
@@ -429,6 +431,7 @@ public class KeyValue implements Writable, HeapSize {
 
   /**
    * Write KeyValue format into a byte array.
+   * 
    * @param row row key
    * @param roffset row offset
    * @param rlength row length
@@ -443,7 +446,7 @@ public class KeyValue implements Writable, HeapSize {
    * @param value column value
    * @param voffset value offset
    * @param vlength value length
-   * @return
+   * @return The newly created byte array. 
    */
   static byte [] createByteArray(final byte [] row, final int roffset,
       final int rlength, final byte [] family, final int foffset, int flength,
@@ -518,7 +521,7 @@ public class KeyValue implements Writable, HeapSize {
    * @param value
    * @param voffset
    * @param vlength
-   * @return
+   * @return The newly created byte array. 
    */
   static byte [] createByteArray(final byte [] row, final int roffset,
         final int rlength,
@@ -562,9 +565,10 @@ public class KeyValue implements Writable, HeapSize {
   //---------------------------------------------------------------------------
   
   /**
-   * @param timestamp
+   * Clones a row.
+   * 
+   * @param timestamp  The new time stamp for the row.
    * @return Clone of bb's key portion with only the row and timestamp filled in.
-   * @throws IOException
    */
   public KeyValue cloneRow(final long timestamp) {
     return new KeyValue(getBuffer(), getRowOffset(), getRowLength(),
@@ -576,15 +580,14 @@ public class KeyValue implements Writable, HeapSize {
    * @return Clone of bb's key portion with type set to Type.Maximum. Use this
    * doing lookups where you are doing getClosest.  Using Maximum, you'll be
    * sure to trip over all of the other key types since Maximum sorts first.
-   * @throws IOException
    */
   public KeyValue cloneMaximum() {
      return createKey(Type.Maximum);
   }
 
-  /*
-   * Make a clone with the new type.
-   * Does not copy value.
+  /**
+   * Make a clone with the new type. Does not copy value.
+   * 
    * @param newtype New type to set on clone of this key.
    * @return Clone of this key with type set to <code>newtype</code>
    */
@@ -1138,7 +1141,7 @@ public class KeyValue implements Writable, HeapSize {
    * @param roffset
    * @param rlength
    * @param rfamilylength Offset of family delimiter in right column.
-   * @return
+   * @return The result of the comparison.
    */
   static int compareColumns(final byte [] left, final int loffset,
       final int llength, final int lfamilylength,
@@ -1172,10 +1175,9 @@ public class KeyValue implements Writable, HeapSize {
 
   /**
    * Splits a column in family:qualifier form into separate byte arrays.
-   * <p>
-   * Catches 
-   * @param c
-   * @return
+   * 
+   * @param c  The column.
+   * @return The parsed column.
    */
   public static byte [][] parseColumn(byte [] c) {
     final byte [][] result = new byte [2][];
@@ -1483,7 +1485,6 @@ public class KeyValue implements Writable, HeapSize {
  
     /**
      * @return Comparator that ignores timestamps; useful counting versions.
-     * @throws IOException
      */
     public KVComparator getComparatorIgnoringTimestamps() {
       KVComparator c = null;

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

@@ -224,8 +224,9 @@ public class Delete implements Writable {
   }
   
   /**
-   * Method for retrieving the delete's lockId
-   * @return
+   * Method for retrieving the delete's lock ID.
+   * 
+   * @return The lock ID.
    */
   public long getLockId() {
 	return this.lockId;

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

@@ -323,7 +323,6 @@ public class HTable {
    * Return the row that matches <i>row</i> exactly, 
    * or the one that immediately preceeds it.
    * 
-   * @param regionName region name
    * @param row row key
    * @param family Column family to look for row in.
    * @return map of values
@@ -345,13 +344,12 @@ public class HTable {
   * Return the row that matches <i>row</i> exactly, 
   * or the one that immediately preceeds it.
   * 
-  * @param regionName region name
   * @param row row key
   * @param family Column family to look for row in.
   * @return map of values
   * @throws IOException
-   * @deprecated As of hbase 0.20.0, replaced by {@link #getRowOrBefore(byte[], byte[]}
-   */
+  * @deprecated As of hbase 0.20.0, replaced by {@link #getRowOrBefore(byte[], byte[])}
+  */
   public RowResult getClosestRowBefore(final byte[] row, final byte[] family)
   throws IOException {
     Result r = getRowOrBefore(row, family);
@@ -374,8 +372,8 @@ public class HTable {
   /**
    * Get a scanner on the current table as specified by the {@link Scan} object
    * 
-   * @param family
-   * @return
+   * @param family  The column family to scan.
+   * @return The scanner.
    * @throws IOException
    * @since 0.20.0
    */
@@ -388,9 +386,9 @@ public class HTable {
   /**
    * Get a scanner on the current table as specified by the {@link Scan} object
    * 
-   * @param family
-   * @param qualifier
-   * @return
+   * @param family  The column family to scan.
+   * @param qualifier  The column qualifier to scan.
+   * @return The scanner.
    * @throws IOException
    * @since 0.20.0
    */
@@ -481,7 +479,7 @@ public class HTable {
    * @param family
    * @param qualifier
    * @param amount
-   * @return
+   * @return The new value.
    * @throws IOException
    */
   public long incrementColumnValue(final byte [] row, final byte [] family, 
@@ -563,9 +561,9 @@ public class HTable {
   
   /**
    * Utility method that verifies Put is well formed.
+   * 
    * @param put
    * @throws IllegalArgumentException
-   * @throws IOException
    */
   private void validatePut(final Put put) throws IllegalArgumentException{
     if(put.isEmpty()) {
@@ -1653,7 +1651,7 @@ public class HTable {
    * @param batchUpdate
    * @throws IOException
    * @deprecated As of hbase 0.20.0, replaced by {@link #delete(Delete)} or
-   * {@link #put(Put)
+   * {@link #put(Put)}
    */ 
   public synchronized void commit(final BatchUpdate batchUpdate) 
   throws IOException {
@@ -1667,7 +1665,7 @@ public class HTable {
    * @param rl Existing row lock
    * @throws IOException
    * @deprecated As of hbase 0.20.0, replaced by {@link #delete(Delete)} or
-   * {@link #put(Put)
+   * {@link #put(Put)}
    */ 
   public synchronized void commit(final BatchUpdate batchUpdate,
       final RowLock rl) 
@@ -1685,8 +1683,8 @@ public class HTable {
    * If autoFlush is false, the updates are buffered
    * @param batchUpdates
    * @throws IOException
-   * @deprecated As of hbase 0.20.0, replaced by {@link #delete(List<Delete>)} or
-   * {@link #put(List<Put>)
+   * @deprecated As of hbase 0.20.0, replaced by {@link #delete(Delete)} or
+   * {@link #put(List)}
    */ 
   public synchronized void commit(final List<BatchUpdate> batchUpdates)
       throws IOException {

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

@@ -92,8 +92,9 @@ public class Result implements Writable {
   }
 
   /**
-   * Return a sorted list of the KeyValues in this result.
-   * @return
+   * Return a sorted list of the KeyValue's in this result.
+   * 
+   * @return The sorted list of KeyValue's.
    */
   public List<KeyValue> list() {
     return Arrays.asList(sorted());

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

@@ -211,7 +211,6 @@ public class Scan implements Writable {
   /**
    * Get up to the specified number of versions of each column.
    * @param maxVersions maximum versions for each column
-   * @throws IOException if invalid number of versions
    */
   public Scan setMaxVersions(int maxVersions) {
     this.maxVersions = maxVersions;
@@ -230,9 +229,10 @@ public class Scan implements Writable {
   /**
    * Set an old-style filter interface to use. Note: not all features of the
    * old style filters are supported.
+   * 
    * @deprecated
    * @param filter
-   * @return
+   * @return The scan instance. 
    */
   public Scan setOldFilter(RowFilterInterface filter) {
     oldFilter = filter;

src/java/org/apache/hadoop/hbase/filter/Filter.java

@@ -77,7 +77,7 @@ public interface Filter extends Writable {
    *
    * @param v the KeyValue in question
    * @return code as described below
-   * @see {@link Filter.ReturnCode}
+   * @see Filter.ReturnCode
    */
   public ReturnCode filterKeyValue(KeyValue v);
 

src/java/org/apache/hadoop/hbase/io/HeapSize.java

@@ -26,7 +26,7 @@ package org.apache.hadoop.hbase.io;
  * do not account for 32 vs 64 bit nor for different VM implementations.
  * <p>
  * An Object's size is determined by the non-static data members in it,
- * as well as the fixed {@link OBJECT} overhead.
+ * as well as the fixed {@link Object} overhead.
  * <p>
  * For example:
  * <pre>

src/java/org/apache/hadoop/hbase/io/RowResult.java

@@ -186,7 +186,7 @@ public class RowResult implements Writable, SortedMap<byte [], Cell>,
    * Get a cell using seperate family, columnQualifier arguments.
    * @param family
    * @param columnQualifier
-   * @return
+   * @return The cell.
    */
   public Cell get(byte [] family, byte [] columnQualifier) {
     return get(Bytes.add(family, KeyValue.COLUMN_FAMILY_DELIM_ARRAY, columnQualifier));

src/java/org/apache/hadoop/hbase/ipc/HRegionInterface.java

@@ -99,9 +99,10 @@ public interface HRegionInterface extends HBaseRPCProtocolVersion {
   
   /**
    * Put an array of puts into the specified region
+   * 
    * @param regionName
    * @param puts
-   * @return
+   * @return The number of processed put's.
    * @throws IOException
    */
   public int put(final byte[] regionName, final Put [] puts)

src/java/org/apache/hadoop/hbase/ipc/TransactionalRegionInterface.java

@@ -138,7 +138,6 @@ public interface TransactionalRegionInterface extends HRegionInterface {
    * @param transactionId
    * @param regionName region name
    * @param delete
-   * @param timestamp Delete all entries that have this timestamp or older
    * @throws IOException
    */
   public void delete(long transactionId, byte [] regionName, Delete delete)

src/java/org/apache/hadoop/hbase/mapred/TableInputFormat.java

@@ -41,9 +41,6 @@ public class TableInputFormat extends TableInputFormatBase implements
 
   /**
    * space delimited list of columns
-   *
-   * @see org.apache.hadoop.hbase.regionserver.HAbstractScanner for column name
-   *      wildcards
    */
   public static final String COLUMN_LIST = "hbase.mapred.tablecolumns";
 

src/java/org/apache/hadoop/hbase/master/HMaster.java

@@ -881,7 +881,7 @@ public class HMaster extends Thread implements HConstants, HMasterInterface,
   /**
    * Get row from meta table.
    * @param row
-   * @param columns
+   * @param family
    * @return Result
    * @throws IOException
    */

src/java/org/apache/hadoop/hbase/master/ZKMasterAddressWatcher.java

@@ -42,7 +42,7 @@ public class ZKMasterAddressWatcher implements Watcher {
 
   /**
    * Create a watcher with a ZooKeeperWrapper instance.
-   * @param zooKeeper ZooKeeperWrapper to use to talk to ZooKeeper.
+   * @param master The master.
    */
   public ZKMasterAddressWatcher(HMaster master) {
     this.master = master;

src/java/org/apache/hadoop/hbase/regionserver/ColumnTracker.java

@@ -33,10 +33,10 @@ import org.apache.hadoop.hbase.regionserver.QueryMatcher.MatchCode;
  * qualifiers within the family.
  * <p>
  * This class is utilized by {@link QueryMatcher} through two methods:
- * <ul><li>{@link checkColumn} is called when a Put satisfies all other
+ * <ul><li>{@link #checkColumn} is called when a Put satisfies all other
  * conditions of the query.  This method returns a {@link MatchCode} to define
  * what action should be taken.
- * <li>{@link update} is called at the end of every StoreFile or Memcache.
+ * <li>{@link #update} is called at the end of every StoreFile or Memcache.
  * <p>
  * This class is NOT thread-safe as queries are never multi-threaded 
  */
@@ -46,20 +46,23 @@ public interface ColumnTracker {
    * @param bytes
    * @param offset
    * @param length
-   * @return
+   * @return The match code instance.
    */
   public MatchCode checkColumn(byte [] bytes, int offset, int length);
+  
   /**
    * Updates internal variables in between files
    */
   public void update();
+  
   /**
    * Resets the Matcher
    */
   public void reset();
+  
   /**
    * 
-   * @return
+   * @return <code>true</code> when done.
    */
   public boolean done();
 

src/java/org/apache/hadoop/hbase/regionserver/DeleteTracker.java

@@ -24,9 +24,9 @@ package org.apache.hadoop.hbase.regionserver;
  * during the course of a Get or Scan operation.
  * <p>
  * This class is utilized through three methods:
- * <ul><li>{@link add} when encountering a Delete
- * <li>{@link isDeleted} when checking if a Put KeyValue has been deleted
- * <li>{@link update} when reaching the end of a StoreFile 
+ * <ul><li>{@link #add} when encountering a Delete
+ * <li>{@link #isDeleted} when checking if a Put KeyValue has been deleted
+ * <li>{@link #update} when reaching the end of a StoreFile 
  */
 public interface DeleteTracker {
   

src/java/org/apache/hadoop/hbase/regionserver/ExplicitColumnTracker.java

@@ -37,10 +37,10 @@ import org.apache.hadoop.hbase.util.Bytes;
  * 
  * <p>
  * This class is utilized by {@link QueryMatcher} through two methods:
- * <ul><li>{@link checkColumn} is called when a Put satisfies all other
+ * <ul><li>{@link #checkColumn} is called when a Put satisfies all other
  * conditions of the query.  This method returns a {@link MatchCode} to define
  * what action should be taken.
- * <li>{@link update} is called at the end of every StoreFile or Memcache.
+ * <li>{@link #update} is called at the end of every StoreFile or Memcache.
  * <p>
  * This class is NOT thread-safe as queries are never multi-threaded 
  */

src/java/org/apache/hadoop/hbase/regionserver/GetDeleteTracker.java

@@ -31,9 +31,9 @@ import org.apache.hadoop.hbase.util.Bytes;
  * during the course of a Get operation.
  * <p>
  * This class is utilized through three methods:
- * <ul><li>{@link add} when encountering a Delete
- * <li>{@link isDeleted} when checking if a Put KeyValue has been deleted
- * <li>{@link update} when reaching the end of a StoreFile
+ * <ul><li>{@link #add} when encountering a Delete
+ * <li>{@link #isDeleted} when checking if a Put KeyValue has been deleted
+ * <li>{@link #update} when reaching the end of a StoreFile
  * <p>
  * This class is NOT thread-safe as queries are never multi-threaded 
  */
@@ -60,9 +60,11 @@ public class GetDeleteTracker implements DeleteTracker {
    * this row operation.
    * <p>
    * This is called when a Delete is encountered in a StoreFile.
-   * @param kv
-   * @param type
+   * @param buffer
+   * @param qualifierOffset
+   * @param qualifierLength
    * @param timestamp
+   * @param type
    */
   @Override
   public void add(byte [] buffer, int qualifierOffset, int qualifierLength,

src/java/org/apache/hadoop/hbase/regionserver/HRegion.java

@@ -245,7 +245,6 @@ public class HRegion implements HConstants { // , Writable{
    * @param flushListener an object that implements CacheFlushListener or null
    * making progress to master -- otherwise master might think region deploy
    * failed.  Can be null.
-   * @throws IOException 
    */
   public HRegion(Path basedir, HLog log, FileSystem fs, HBaseConfiguration conf, 
       HRegionInfo regionInfo, FlushRequester flushListener) {
@@ -1006,7 +1005,6 @@ public class HRegion implements HConstants { // , Writable{
    * 
    * @param row row key
    * @param family
-   * @param columnFamily Must include the column family delimiter character.
    * @return map of values
    * @throws IOException
    */
@@ -1324,7 +1322,7 @@ public class HRegion implements HConstants { // , Writable{
    * to replace LATEST_TIMESTAMP with now.
    * @param keys
    * @param now
-   * @return
+   * @return <code>true</code> when updating the time stamp completed.
    */
   private boolean updateKeys(List<KeyValue> keys, byte [] now) {
     if(keys == null || keys.isEmpty()) {
@@ -1419,9 +1417,9 @@ public class HRegion implements HConstants { // , Writable{
   /** 
    * Add updates first to the hlog (if writeToWal) and then add values to memcache.
    * Warning: Assumption is caller has lock on passed in row.
+   * @param family
+   * @param edits
    * @param writeToWAL if true, then we should write to the log
-   * @param updatesByColumn Cell updates by column
-   * @param now
    * @throws IOException
    */
   private void put(final byte [] family, final List<KeyValue> edits, 
@@ -1577,7 +1575,7 @@ public class HRegion implements HConstants { // , Writable{
   
   /** 
    * Release the row lock!
-   * @param row Name of row whose lock we are to release
+   * @param lockid  The lock ID to release.
    */
   void releaseRowLock(final Integer lockid) {
     synchronized (locksToRows) {
@@ -2256,7 +2254,7 @@ public class HRegion implements HConstants { // , Writable{
    * @param family
    * @param qualifier
    * @param amount
-   * @return
+   * @return The new value.
    * @throws IOException
    */
   public long incrementColumnValue(byte [] row, byte [] family,

src/java/org/apache/hadoop/hbase/regionserver/QueryMatcher.java

@@ -38,8 +38,8 @@ import org.apache.hadoop.hbase.util.Bytes;
  * <p>
  * All other query parameters are accessed from the client-specified Get.
  * <p>
- * The primary method used is {@link match} with the current KeyValue.  It will
- * return a {@link MatchCode} 
+ * The primary method used is {@link #match} with the current KeyValue.  It will
+ * return a {@link QueryMatcher.MatchCode} 
  * 
  * , deletes,
  * versions, 
@@ -47,7 +47,7 @@ import org.apache.hadoop.hbase.util.Bytes;
 public class QueryMatcher {
   
   /**
-   * {@link match} return codes.  These instruct the scanner moving through
+   * {@link #match} return codes.  These instruct the scanner moving through
    * Memcaches and StoreFiles what to do with the current KeyValue.
    * <p>
    * Additionally, this contains "early-out" language to tell the scanner to
@@ -281,7 +281,7 @@ public class QueryMatcher {
     return (timestamp < oldestStamp);
   }
 
-   /**
+  /**
    * If matcher returns SEEK_NEXT_COL you may be able
    * to get a hint of the next column to seek to - call this.
    * If it returns null, there is no hint.
@@ -320,7 +320,6 @@ public class QueryMatcher {
     this.row = row;
   }
   
-
   /**
    * 
    * @return the start key
@@ -363,9 +362,10 @@ public class QueryMatcher {
   public DeleteTracker getDeleteTracker() {
     return this.deletes;
   }
+  
   /**
    * 
-   * @return
+   * @return <code>true</code> when done.
    */
   public boolean isDone() {
     return this.columns.done();

src/java/org/apache/hadoop/hbase/regionserver/ScanDeleteTracker.java

@@ -31,9 +31,9 @@ import org.apache.hadoop.hbase.KeyValue;
  *
  * <p>
  * This class is utilized through three methods:
- * <ul><li>{@link add} when encountering a Delete or DeleteColumn
- * <li>{@link isDeleted} when checking if a Put KeyValue has been deleted
- * <li>{@link update} when reaching the end of a StoreFile or row for scans
+ * <ul><li>{@link #add} when encountering a Delete or DeleteColumn
+ * <li>{@link #isDeleted} when checking if a Put KeyValue has been deleted
+ * <li>{@link #update} when reaching the end of a StoreFile or row for scans
  * <p>
  * This class is NOT thread-safe as queries are never multi-threaded 
  */

src/java/org/apache/hadoop/hbase/regionserver/ScanQueryMatcher.java

@@ -85,8 +85,7 @@ public class ScanQueryMatcher extends QueryMatcher {
    * - got to the next row (MatchCode.DONE)
    * 
    * @param kv KeyValue to check
-   * @return
-   * @throws IOException
+   * @return The match code instance.
    */
   public MatchCode match(KeyValue kv) {
     if (filter != null && filter.filterAllRemaining()) {
@@ -213,7 +212,8 @@ public class ScanQueryMatcher extends QueryMatcher {
   /**
    * If the row was otherwise going to be included, call this to last-minute
    * check.
-   * @return
+   * 
+   * @return <code>true</code> if the row should be filtered.
    */
   public boolean filterEntireRow() {
     if (filter == null)

src/java/org/apache/hadoop/hbase/regionserver/ScanWildcardColumnTracker.java

@@ -49,7 +49,7 @@ public class ScanWildcardColumnTracker implements ColumnTracker {
    * @param bytes
    * @param offset
    * @param length
-   * @return
+   * @return The match code instance.
    */
   @Override
   public MatchCode checkColumn(byte[] bytes, int offset, int length) {
@@ -106,7 +106,8 @@ public class ScanWildcardColumnTracker implements ColumnTracker {
    * Used by matcher and scan/get to get a hint of the next column
    * to seek to after checkColumn() returns SKIP.  Returns the next interesting
    * column we want, or NULL there is none (wildcard scanner).
-   * @return
+   * 
+   * @return The column count.
    */
   public ColumnCount getColumnHint() {
     return null;

src/java/org/apache/hadoop/hbase/regionserver/Store.java

@@ -1353,8 +1353,6 @@ public class Store implements HConstants {
 
   /**
    * @return The size of the store file indexes, in bytes.
-   * @throws IOException if there was a problem getting file sizes from the
-   * filesystem
    */
   long getStorefilesIndexSize() {
     long size = 0;
@@ -1490,7 +1488,7 @@ public class Store implements HConstants {
    * @param family
    * @param qualifier
    * @param amount
-   * @return
+   * @return The new value.
    * @throws IOException
    */
   public long incrementColumnValue(byte [] row, byte [] family,

src/java/org/apache/hadoop/hbase/regionserver/StoreFile.java

@@ -26,7 +26,6 @@ import org.apache.hadoop.fs.Path;
 import org.apache.hadoop.hbase.HBaseConfiguration;
 import org.apache.hadoop.hbase.HConstants;
 import org.apache.hadoop.hbase.KeyValue;
-import org.apache.hadoop.hbase.HBaseConfiguration;
 import org.apache.hadoop.hbase.io.HalfHFileReader;
 import org.apache.hadoop.hbase.io.Reference;
 import org.apache.hadoop.hbase.io.hfile.BlockCache;
@@ -213,9 +212,10 @@ public class StoreFile implements HConstants {
   }
 
   /**
+   * Returns the block cache or <code>null</code> in case none should be used.
    * 
-   * @param conf
-   * @return
+   * @param conf  The current configuration.
+   * @return The block cache or <code>null</code>.
    */
   public static synchronized BlockCache getBlockCache(HBaseConfiguration conf) {
     if (hfileBlockCache != null)

src/java/org/apache/hadoop/hbase/regionserver/WildcardColumnTracker.java

@@ -31,10 +31,10 @@ import org.apache.hadoop.hbase.util.Bytes;
  * column qualifiers have been asked for in the query.
  * <p>
  * This class is utilized by {@link QueryMatcher} through two methods:
- * <ul><li>{@link checkColumn} is called when a Put satisfies all other
+ * <ul><li>{@link #checkColumn} is called when a Put satisfies all other
  * conditions of the query.  This method returns a {@link MatchCode} to define
  * what action should be taken.
- * <li>{@link update} is called at the end of every StoreFile or Memcache.
+ * <li>{@link #update} is called at the end of every StoreFile or Memcache.
  * <p>
  * This class is NOT thread-safe as queries are never multi-threaded 
  */

src/java/org/apache/hadoop/hbase/thrift/generated/Hbase.java

@@ -41,8 +41,6 @@ public class Hbase {
     /**
      * Brings a table on-line (enables it)
      * @param tableName name of the table
-     * 
-     * @param tableName
      */
     public void enableTable(byte[] tableName) throws IOError, TException;
 
@@ -50,16 +48,12 @@ public class Hbase {
      * Disables a table (takes it off-line) If it is being served, the master
      * will tell the servers to stop serving it.
      * @param tableName name of the table
-     * 
-     * @param tableName
      */
     public void disableTable(byte[] tableName) throws IOError, TException;
 
     /**
      * @param tableName name of table to check
      * @return true if table is on-line
-     * 
-     * @param tableName
      */
     public boolean isTableEnabled(byte[] tableName) throws IOError, TException;
 
@@ -77,8 +71,6 @@ public class Hbase {
      * List all the column families assoicated with a table.
      * @param tableName table name
      * @return list of column family descriptors
-     * 
-     * @param tableName
      */
     public Map<byte[],ColumnDescriptor> getColumnDescriptors(byte[] tableName) throws IOError, TException;
 
@@ -86,8 +78,6 @@ public class Hbase {
      * List the regions associated with a table.
      * @param tableName table name
      * @return list of region descriptors
-     * 
-     * @param tableName
      */
     public List<TRegionInfo> getTableRegions(byte[] tableName) throws IOError, TException;
 
@@ -102,9 +92,6 @@ public class Hbase {
      * 
      * @throws IllegalArgument if an input parameter is invalid
      * @throws AlreadyExists if the table name already exists
-     * 
-     * @param tableName
-     * @param columnFamilies
      */
     public void createTable(byte[] tableName, List<ColumnDescriptor> columnFamilies) throws IOError, IllegalArgument, AlreadyExists, TException;
 
@@ -113,8 +100,6 @@ public class Hbase {
      * @param tableName name of table to delete
      * @throws IOError if table doesn't exist on server or there was some other
      * problem
-     * 
-     * @param tableName
      */
     public void deleteTable(byte[] tableName) throws IOError, TException;
 
@@ -126,10 +111,6 @@ public class Hbase {
      * @param row row key
      * @param column column name
      * @return value for specified row/column
-     * 
-     * @param tableName
-     * @param row
-     * @param column
      */
     public List<TCell> get(byte[] tableName, byte[] row, byte[] column) throws IOError, TException;
 
@@ -142,11 +123,6 @@ public class Hbase {
      * @param column column name
      * @param numVersions number of versions to retrieve
      * @return list of cells for specified row/column
-     * 
-     * @param tableName
-     * @param row
-     * @param column
-     * @param numVersions
      */
     public List<TCell> getVer(byte[] tableName, byte[] row, byte[] column, int numVersions) throws IOError, TException;
 
@@ -161,12 +137,6 @@ public class Hbase {
      * @param timestamp timestamp
      * @param numVersions number of versions to retrieve
      * @return list of cells for specified row/column
-     * 
-     * @param tableName
-     * @param row
-     * @param column
-     * @param timestamp
-     * @param numVersions
      */
     public List<TCell> getVerTs(byte[] tableName, byte[] row, byte[] column, long timestamp, int numVersions) throws IOError, TException;
 
@@ -177,9 +147,6 @@ public class Hbase {
      * @param tableName name of table
      * @param row row key
      * @return TRowResult containing the row and map of columns to TCells
-     * 
-     * @param tableName
-     * @param row
      */
     public List<TRowResult> getRow(byte[] tableName, byte[] row) throws IOError, TException;
 
@@ -191,10 +158,6 @@ public class Hbase {
      * @param row row key
      * @param columns List of columns to return, null for all columns
      * @return TRowResult containing the row and map of columns to TCells
-     * 
-     * @param tableName
-     * @param row
-     * @param columns
      */
     public List<TRowResult> getRowWithColumns(byte[] tableName, byte[] row, List<byte[]> columns) throws IOError, TException;
 
@@ -206,10 +169,6 @@ public class Hbase {
      * @param row row key
      * @param timestamp timestamp
      * @return TRowResult containing the row and map of columns to TCells
-     * 
-     * @param tableName
-     * @param row
-     * @param timestamp
      */
     public List<TRowResult> getRowTs(byte[] tableName, byte[] row, long timestamp) throws IOError, TException;
 
@@ -221,11 +180,6 @@ public class Hbase {
      * @param row row key
      * @param columns List of columns to return, null for all columns
      * @return TRowResult containing the row and map of columns to TCells
-     * 
-     * @param tableName
-     * @param row
-     * @param columns
-     * @param timestamp
      */
     public List<TRowResult> getRowWithColumnsTs(byte[] tableName, byte[] row, List<byte[]> columns, long timestamp) throws IOError, TException;
 
@@ -238,10 +192,6 @@ public class Hbase {
      * @param tableName name of table
      * @param row row key
      * @param mutations list of mutation commands
-     * 
-     * @param tableName
-     * @param row
-     * @param mutations
      */
     public void mutateRow(byte[] tableName, byte[] row, List<Mutation> mutations) throws IOError, IllegalArgument, TException;
 
@@ -255,11 +205,6 @@ public class Hbase {
      * @param row row key
      * @param mutations list of mutation commands
      * @param timestamp timestamp
-     * 
-     * @param tableName
-     * @param row
-     * @param mutations
-     * @param timestamp
      */
     public void mutateRowTs(byte[] tableName, byte[] row, List<Mutation> mutations, long timestamp) throws IOError, IllegalArgument, TException;
 
@@ -271,9 +216,6 @@ public class Hbase {
      * 
      * @param tableName name of table
      * @param rowBatches list of row batches
-     * 
-     * @param tableName
-     * @param rowBatches
      */
     public void mutateRows(byte[] tableName, List<BatchMutation> rowBatches) throws IOError, IllegalArgument, TException;
 
@@ -286,10 +228,6 @@ public class Hbase {
      * @param tableName name of table
      * @param rowBatches list of row batches
      * @param timestamp timestamp
-     * 
-     * @param tableName
-     * @param rowBatches
-     * @param timestamp
      */
     public void mutateRowsTs(byte[] tableName, List<BatchMutation> rowBatches, long timestamp) throws IOError, IllegalArgument, TException;
 
@@ -299,11 +237,6 @@ public class Hbase {
      * @param row row to increment
      * @param column name of column
      * @param value amount to increment by
-     * 
-     * @param tableName
-     * @param row
-     * @param column
-     * @param value
      */
     public long atomicIncrement(byte[] tableName, byte[] row, byte[] column, long value) throws IOError, IllegalArgument, TException;
 
@@ -313,10 +246,6 @@ public class Hbase {
      * @param tableName name of table
      * @param row Row to update
      * @param column name of column whose value is to be deleted
-     * 
-     * @param tableName
-     * @param row
-     * @param column
      */
     public void deleteAll(byte[] tableName, byte[] row, byte[] column) throws IOError, TException;
 
@@ -328,11 +257,6 @@ public class Hbase {
      * @param row Row to update
      * @param column name of column whose value is to be deleted
      * @param timestamp timestamp
-     * 
-     * @param tableName
-     * @param row
-     * @param column
-     * @param timestamp
      */
     public void deleteAllTs(byte[] tableName, byte[] row, byte[] column, long timestamp) throws IOError, TException;
 
@@ -341,9 +265,6 @@ public class Hbase {
      * 
      * @param tableName name of table
      * @param row key of the row to be completely deleted.
-     * 
-     * @param tableName
-     * @param row
      */
     public void deleteAllRow(byte[] tableName, byte[] row) throws IOError, TException;
 
@@ -354,10 +275,6 @@ public class Hbase {
      * @param tableName name of table
      * @param row key of the row to be completely deleted.
      * @param timestamp timestamp
-     * 
-     * @param tableName
-     * @param row
-     * @param timestamp
      */
     public void deleteAllRowTs(byte[] tableName, byte[] row, long timestamp) throws IOError, TException;
 
@@ -373,10 +290,6 @@ public class Hbase {
      *                 start at the first row.
      * 
      * @return scanner id to be used with other scanner procedures
-     * 
-     * @param tableName
-     * @param startRow
-     * @param columns
      */
     public int scannerOpen(byte[] tableName, byte[] startRow, List<byte[]> columns) throws IOError, TException;
 
@@ -395,11 +308,6 @@ public class Hbase {
      *                scanner's results
      * 
      * @return scanner id to be used with other scanner procedures
-     * 
-     * @param tableName
-     * @param startRow
-     * @param stopRow
-     * @param columns
      */
     public int scannerOpenWithStop(byte[] tableName, byte[] startRow, byte[] stopRow, List<byte[]> columns) throws IOError, TException;
 
@@ -417,11 +325,6 @@ public class Hbase {
      * @param timestamp timestamp
      * 
      * @return scanner id to be used with other scanner procedures
-     * 
-     * @param tableName
-     * @param startRow
-     * @param columns
-     * @param timestamp
      */
     public int scannerOpenTs(byte[] tableName, byte[] startRow, List<byte[]> columns, long timestamp) throws IOError, TException;
 
@@ -442,12 +345,6 @@ public class Hbase {
      * @param timestamp timestamp
      * 
      * @return scanner id to be used with other scanner procedures
-     * 
-     * @param tableName
-     * @param startRow
-     * @param stopRow
-     * @param columns
-     * @param timestamp
      */
     public int scannerOpenWithStopTs(byte[] tableName, byte[] startRow, byte[] stopRow, List<byte[]> columns, long timestamp) throws IOError, TException;
 
@@ -461,8 +358,6 @@ public class Hbase {
      * @return a TRowResult containing the current row and a map of the columns to TCells.
      * @throws IllegalArgument if ScannerID is invalid
      * @throws NotFound when the scanner reaches the end
-     * 
-     * @param id
      */
     public List<TRowResult> scannerGet(int id) throws IOError, IllegalArgument, TException;
 
@@ -477,9 +372,6 @@ public class Hbase {
      * @return a TRowResult containing the current row and a map of the columns to TCells.
      * @throws IllegalArgument if ScannerID is invalid
      * @throws NotFound when the scanner reaches the end
-     * 
-     * @param id
-     * @param nbRows
      */
     public List<TRowResult> scannerGetList(int id, int nbRows) throws IOError, IllegalArgument, TException;
 
@@ -488,8 +380,6 @@ public class Hbase {
      * 
      * @param id id of a scanner returned by scannerOpen
      * @throws IllegalArgument if ScannerID is invalid
-     * 
-     * @param id
      */
     public void scannerClose(int id) throws IOError, IllegalArgument, TException;
 

src/java/org/apache/hadoop/hbase/util/Bytes.java

@@ -24,7 +24,6 @@ import java.io.DataOutput;
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 import java.nio.ByteBuffer;
-import java.nio.charset.Charset;
 import java.util.Comparator;
 import java.math.BigInteger;
 
@@ -33,8 +32,6 @@ import org.apache.hadoop.hbase.io.ImmutableBytesWritable;
 import org.apache.hadoop.io.RawComparator;
 import org.apache.hadoop.io.WritableComparator;
 import org.apache.hadoop.io.WritableUtils;
-import org.apache.commons.logging.LogFactory;
-import org.apache.commons.logging.Log;
 
 /**
  * Utility class that handles byte arrays, conversions to/from other types,
@@ -307,8 +304,8 @@ public class Bytes {
   /**
    * Takes a ASCII digit in the range A-F0-9 and returns
    * the corresponding integer/ordinal value.
-   * @param ch
-   * @return
+   * @param ch  The hex digit.
+   * @return The converted hex value as a byte.
    */
   public static byte toBinaryFromHex(byte ch) {
     if ( ch >= 'A' && ch <= 'F' )
@@ -658,7 +655,7 @@ public class Bytes {
    * Converts a byte array to a short value
    * @param bytes
    * @param offset
-   * @param lengths
+   * @param length
    * @return the short value
    */
   public static short toShort(byte[] bytes, int offset, final int length) {