HBASE-1340 Fix new javadoc warnings

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

CHANGES.txt

@@ -86,6 +86,7 @@ Release 0.20.0 - Unreleased
    HBASE-1058  Prevent runaway compactions
    HBASE-1292  php thrift's getRow() would throw an exception if the row does
                not exist (Rong-en Fan via Stack)
+   HBASE-1340  Fix new javadoc warnings (Evgeny Ryabitskiy via Stack)
 
   IMPROVEMENTS
    HBASE-1089  Add count of regions on filesystem to master UI; add percentage

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

@@ -59,7 +59,7 @@ public class HColumnDescriptor implements ISerializable, WritableComparable<HCol
   /** 
    * The type of compression.
    * @see org.apache.hadoop.io.SequenceFile.Writer
-   * @deprecated Replaced by {@link Compression.Algorithm}.
+   * @deprecated
    */
   @Deprecated
   public static enum CompressionType {

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

@@ -23,6 +23,7 @@ import java.io.IOException;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.apache.hadoop.hbase.io.hfile.HFile;
 import org.apache.hadoop.hbase.util.Bytes;
 import org.apache.hadoop.io.RawComparator;
 
@@ -227,62 +228,56 @@ public class KeyValue {
   }
   
   /**
-   * @param row
+   * Constructs KeyValue structure filled with null value.
+   * @param row - row key (arbitrary byte array)
    * @param timestamp
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final String row, final long timestamp) {
     this(Bytes.toBytes(row), timestamp);
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with null value.
+   * @param row - row key (arbitrary byte array)
    * @param timestamp
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final byte [] row, final long timestamp) {
     this(row, null, timestamp, Type.Put, null);
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with null value.
+   * @param row - row key (arbitrary byte array)
    * @param column Column with delimiter between family and qualifier
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final String row, final String column) {
     this(row, column, null);
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with null value.
+   * @param row - row key (arbitrary byte array)
    * @param column Column with delimiter between family and qualifier
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final byte [] row, final byte [] column) {
     this(row, column, null);
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with specified value.
+   * @param row - row key (arbitrary byte array)
    * @param column Column with delimiter between family and qualifier
    * @param value
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final String row, final String column, final byte [] value) {
     this(Bytes.toBytes(row), Bytes.toBytes(column), value);
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with specified value.
+   * @param row - row key (arbitrary byte array)
    * @param column Column with delimiter between family and qualifier
    * @param value
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final byte [] row, final byte [] column, final byte [] value) {
     this(row, column, HConstants.LATEST_TIMESTAMP, value);
@@ -290,34 +285,31 @@ public class KeyValue {
 
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with null value.
+   * @param row - row key (arbitrary byte array)
    * @param column Column with delimiter between family and qualifier
    * @param ts
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final String row, final String column, final long ts) {
     this(row, column, ts, null);
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with null value.
+   * @param row - row key (arbitrary byte array)
    * @param column Column with delimiter between family and qualifier
    * @param ts
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final byte [] row, final byte [] column, final long ts) {
     this(row, column, ts, Type.Put);
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with specified value.
+   * @param row - row key (arbitrary byte array)
    * @param column Column with delimiter between family and qualifier
    * @param timestamp
    * @param value
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final String row, final String column,
     final long timestamp, final byte [] value) {
@@ -327,12 +319,11 @@ public class KeyValue {
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with specified value.
+   * @param row - row key (arbitrary byte array)
    * @param column Column with delimiter between family and qualifier
    * @param timestamp
    * @param value
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final byte [] row, final byte [] column,
      final long timestamp, final byte [] value) {
@@ -340,13 +331,12 @@ public class KeyValue {
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with specified value.
+   * @param row - row key (arbitrary byte array)
    * @param column Column with delimiter between family and qualifier
    * @param timestamp
    * @param type
    * @param value
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final String row, final String column,
      final long timestamp, final Type type, final byte [] value) {
@@ -355,12 +345,11 @@ public class KeyValue {
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with null value.
+   * @param row - row key (arbitrary byte array)
    * @param column Column with delimiter between family and qualifier
    * @param timestamp
    * @param type
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final byte [] row, final byte [] column,
       final long timestamp, final Type type) {
@@ -369,13 +358,12 @@ public class KeyValue {
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with specified value.
+   * @param row - row key (arbitrary byte array)
    * @param column Column with delimiter between family and qualifier
    * @param timestamp
    * @param type
    * @param value
-   * @return KeyValue structure filled with specified values.
-   * @throws IllegalArgumentException
    */
   public KeyValue(final byte [] row, final byte [] column,
       final long timestamp, final Type type, final byte [] value) {
@@ -384,7 +372,8 @@ public class KeyValue {
   }
 
   /**
-   * @param row
+   * Constructs KeyValue structure filled with specified value.
+   * @param row - row key (arbitrary byte array)
    * @param roffset
    * @param rlength
    * @param column Column with delimiter between family and qualifier
@@ -395,7 +384,6 @@ public class KeyValue {
    * @param value
    * @param voffset
    * @param vlength
-   * @return KeyValue
    * @throws IllegalArgumentException
    */
   public KeyValue(final byte [] row, final int roffset, final int rlength,
@@ -410,7 +398,7 @@ public class KeyValue {
 
   /**
    * Write KeyValue format into a byte array.
-   * @param row
+   * @param row - row key (arbitrary byte array)
    * @param roffset
    * @param rlength
    * @param column
@@ -541,7 +529,7 @@ public class KeyValue {
   }
 
   /**
-   * @param b Key portion of a KeyValue.
+   * @param k Key portion of a KeyValue.
    * @return Key as a String.
    */
   public static String keyToString(final byte [] k) {
@@ -742,7 +730,7 @@ public class KeyValue {
   }
 
   /**
-   * @param rowlength Pass if you have it to save on an int creation.
+   * @param rowlength - length of row.
    * @return Offset into backing buffer at which the column begins
    */
   public int getColumnOffset(final int rowlength) {
@@ -1031,8 +1019,8 @@ public class KeyValue {
 
     /**
      * @param left
-     * @param row
-     * @return
+     * @param row - row key (arbitrary byte array)
+     * @return RawComparator
      */
     public int compareRows(final KeyValue left, final byte [] row) {
       return getRawComparator().compareRows(left.getBuffer(),
@@ -1169,7 +1157,6 @@ public class KeyValue {
 
     /**
      * @return Comparator that ignores key type; useful checking deletes
-     * @throws IOException
      */
     public KVComparator getComparatorIgnoringType() {
       KVComparator c = null;
@@ -1184,7 +1171,7 @@ public class KeyValue {
   }
 
   /**
-   * @param row
+   * @param row - row key (arbitrary byte array)
    * @return First possible KeyValue on passed <code>row</code>
    */
   public static KeyValue createFirstOnRow(final byte [] row) {
@@ -1192,8 +1179,8 @@ public class KeyValue {
   }
 
   /**
-   * @param row
-   * @param ts
+   * @param row - row key (arbitrary byte array)
+   * @param ts - timestamp
    * @return First possible key on passed <code>row</code> and timestamp.
    */
   public static KeyValue createFirstOnRow(final byte [] row,
@@ -1202,8 +1189,8 @@ public class KeyValue {
   }
 
   /**
-   * @param row
-   * @param ts
+   * @param row - row key (arbitrary byte array)
+   * @param ts - timestamp
    * @return First possible key on passed <code>row</code>, column and timestamp.
    */
   public static KeyValue createFirstOnRow(final byte [] row, final byte [] c,

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

@@ -115,12 +115,13 @@ public interface RowFilterInterface extends Writable {
    * but the rest of the row will still get through.
    * 
    * @param rowKey row key to filter on.
-   * @param colunmName column name to filter on
+   * @param columnName column name to filter on
    * @param columnValue column value to filter on
    * @return true if row filtered and should not be processed.
    * @deprecated Use {@link #filterColumn(byte[], int, int, byte[], int, int, byte[], int, int)}
    * instead.
    */
+  @Deprecated
   boolean filterColumn(final byte [] rowKey, final byte [] columnName,
       final byte [] columnValue);
 

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

@@ -268,7 +268,7 @@ public class RowResult implements Writable, SortedMap<byte [], Cell>,
   }  
 
   /**
-   * @param r
+   * @param l
    * @return
    * TODO: This is the glue between old way of doing things and the new.
    * Herein we are converting our clean KeyValues to old RowResult.

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

@@ -1787,18 +1787,16 @@ public class SequenceFile {
       return valClass;
     }
 
-    /** Returns true if values are compressed. 
-     * @return
-     */
+    /** @return true if values are compressed. */
     public boolean isCompressed() { return decompress; }
     
-    /** Returns true if records are block-compressed. */
+    /** @return true if records are block-compressed. */
     public boolean isBlockCompressed() { return blockCompressed; }
     
-    /** Returns the compression codec of data in this file. */
+    /** @return the compression codec of data in this file. */
     public CompressionCodec getCompressionCodec() { return codec; }
 
-    /** Returns the metadata object of the file */
+    /** @return the metadata object of the file */
     public Metadata getMetadata() {
       return this.metadata;
     }

src/java/org/apache/hadoop/hbase/io/hfile/HFile.java

@@ -271,7 +271,6 @@ public class HFile {
      * @param blocksize
      * @param compress
      * @param c RawComparator to use.
-     * @param c
      * @throws IOException
      */
     public Writer(final FSDataOutputStream ostream, final int blocksize,

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

@@ -46,7 +46,7 @@ import org.apache.hadoop.util.StringUtils;
 
 /**
  * A Base for {@link TableInputFormat}s. Receives a {@link HTable}, a
- * {@link Text}[] of input columns and optionally a {@link RowFilterInterface}.
+ * byte[] of input columns and optionally a {@link RowFilterInterface}.
  * Subclasses may use other TableRecordReader implementations.
  * <p>
  * An example of a subclass:

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

@@ -80,7 +80,6 @@ public abstract class HAbstractScanner implements InternalScanner {
    * Compare the column family and column key using the matchers. The first one
    * that matches returns true. If no matchers are successful, return false.
    * 
-   * @param family/store key
    * @param kv KeyValue to test
    * @return true if any of the matchers for the column match the column family
    * and the column key.

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

@@ -341,7 +341,7 @@ implements HeapSize, Map<K,V> {
   /**
    * Deletes the mapping for the specified key if it exists.
    *
-   * @param o the key of the entry to be removed from the map
+   * @param key the key of the entry to be removed from the map
    * @return the value associated with the specified key, or null
    * if no mapping exists.
    */

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

@@ -1008,13 +1008,14 @@ public class Store implements HConstants {
    * row and timestamp, but not a column name.
    *
    * The returned object should map column names to Cells.
-   * @param origin Where to start searching.  Specifies a row and timestamp.
+   * @param key -  Where to start searching.  Specifies a row.
    * Columns are specified in following arguments.
    * @param columns Can be null which means get all
    * @param columnPattern Can be null.
    * @param numVersions
    * @param versionsCounter Can be null.
    * @param keyvalues
+   * @param now -  Where to start searching.  Specifies a timestamp.
    * @throws IOException
    */
   public void getFull(KeyValue key, final NavigableSet<byte []> columns,

src/java/org/apache/hadoop/hbase/rest/filter/RowFilterSetFactory.java

@@ -85,7 +85,7 @@ public class RowFilterSetFactory implements FilterFactory {
    * }
    * 
    * @param filter
-   * @return
+   * @return RowFilter
    * @throws org.apache.hadoop.hbase.rest.exception.HBaseRestException
    */
   protected RowFilterInterface getRowFilter(JSONObject filter)

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

@@ -161,9 +161,9 @@ public class Bytes {
 
   /**
    * Write a long value out to the specified byte array position.
-   * @param bytes the byte array
-   * @param offset position in the array
-   * @param b byte to write out
+   * @param tgtBytes the byte array
+   * @param tgtOffset position in the array
+   * @param srcBytes byte to write out
    * @return incremented offset
    */
   public static int putBytes(byte[] tgtBytes, int tgtOffset, byte[] srcBytes,
@@ -687,7 +687,7 @@ public class Bytes {
    * @param offset the offset in the key you want to find
    * @param length the length of the key
    * @param comparator a comparator to compare.
-   * @return
+   * @return index of key
    */
   public static int binarySearch(byte [][]arr, byte []key, int offset, int length,
       RawComparator<byte []> comparator) {