HBASE-7356 Fix all javadoc warnings in all modules but hbase-server

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

hbase-common/src/main/java/org/apache/hadoop/hbase/KeyValue.java

@@ -2317,7 +2317,7 @@ public class KeyValue implements Cell, HeapSize {
    * @param out
    * @return Length written on stream
    * @throws IOException
-   * @see {@link #create(DataInput)} for the inverse function
+   * @see #create(DataInput) for the inverse function
    */
   public static long write(final KeyValue kv, final DataOutput out) throws IOException {
     // This is how the old Writables write used to serialize KVs.  Need to figure way to make it work for all

hbase-common/src/main/java/org/apache/hadoop/hbase/KeyValueTool.java

@@ -189,7 +189,7 @@ public class KeyValueTool {
    *
    * Remember timestamps are sorted reverse chronologically.
    * @param in
-   * @return
+   * @return previous key
    */
   public static KeyValue previousKey(final KeyValue in) {
     return KeyValue.createFirstOnRow(CellTool.getRowArray(in), CellTool.getFamilyArray(in),

hbase-common/src/main/java/org/apache/hadoop/hbase/util/ByteBufferUtils.java

@@ -318,7 +318,7 @@ public final class ByteBufferUtils {
       }
     }
   }
-  
+
   /**
    * Copy from the InputStream to a new heap ByteBuffer until the InputStream is exhausted.
    */
@@ -378,7 +378,7 @@ public final class ByteBufferUtils {
    * @param leftOffset Offset in left array.
    * @param leftLength Length of left array.
    * @param right Array to be compared.
-   * @param rightArray Offset in right array.
+   * @param rightOffset Offset in right array.
    * @param rightLength Length of right array.
    */
   public static int findCommonPrefix(
@@ -402,7 +402,7 @@ public final class ByteBufferUtils {
    * @param lengthLeft Length of the first part.
    * @param offsetRight Beginning of the second part.
    * @param lengthRight Length of the second part.
-   * @return
+   * @return True if equal
    */
   public static boolean arePartsEqual(ByteBuffer buffer,
       int offsetLeft, int lengthLeft,

hbase-common/src/main/java/org/apache/hadoop/hbase/util/ByteRange.java

@@ -147,7 +147,7 @@ public class ByteRange implements Comparable<ByteRange> {
   /**
    * Create a new ByteRange with new backing byte[] and copy the state of this range into the new
    * range.  Copy the hash over if it is already calculated.
-   * @return 
+   * @return Deep copy
    */
   public ByteRange deepCopy() {
     ByteRange clone = new ByteRange(deepCopyToNewArray());
@@ -161,7 +161,6 @@ public class ByteRange implements Comparable<ByteRange> {
    * Wrapper for System.arraycopy.  Copy the contents of this range into the provided array.
    * @param destination Copy to this array
    * @param destinationOffset First index in the destination array.
-   * @return void to avoid confusion between which ByteRange should be returned
    */
   public void deepCopyTo(byte[] destination, int destinationOffset) {
     System.arraycopy(bytes, offset, destination, destinationOffset, length);
@@ -174,7 +173,6 @@ public class ByteRange implements Comparable<ByteRange> {
    * @param copyLength Copy this many bytes
    * @param destination Copy to this array
    * @param destinationOffset First index in the destination array.
-   * @return void to avoid confusion between which ByteRange should be returned
    */
   public void deepCopySubRangeTo(int innerOffset, int copyLength, byte[] destination,
       int destinationOffset) {

hbase-common/src/main/java/org/apache/hbase/Cell.java

@@ -46,7 +46,7 @@ import org.apache.hbase.cell.CellTool;
  * or debugging code. These should be placed in a sub-interface or the {@link CellTool} class.
  * <p/>
  * Cell implements Comparable<Cell> which is only meaningful when comparing to other keys in the
- * same table. It uses {@link #CellComparator} which does not work on the -ROOT- and .META. tables.
+ * same table. It uses CellComparator which does not work on the -ROOT- and .META. tables.
  * <p/>
  * In the future, we may consider adding a boolean isOnHeap() method and a getValueBuffer() method
  * that can be used to pass a value directly from an off-heap ByteBuffer to the network without
@@ -133,7 +133,6 @@ public interface Cell {
   //5) Type
 
   /**
-   * see {@link #KeyValue.TYPE}
    * @return The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
    */
   byte getTypeByte();

hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsRegionServerSourceFactory.java

@@ -35,7 +35,7 @@ public interface MetricsRegionServerSourceFactory {
    * Create a MetricsRegionSource from a MetricsRegionWrapper.
    *
    * @param wrapper
-   * @return
+   * @return A metrics region source
    */
   MetricsRegionSource createRegion(MetricsRegionWrapper wrapper);
 }

hbase-hadoop1-compat/src/main/java/org/apache/hadoop/hbase/mapreduce/JobUtil.java

@@ -45,7 +45,7 @@ public abstract class JobUtil {
   /**
    * Initializes the staging directory and returns the path.
    *
-   * @parms conf system configuration
+   * @param conf system configuration
    * @return staging directory path
    * @throws IOException
    * @throws InterruptedException

hbase-hadoop2-compat/src/main/java/org/apache/hadoop/hbase/mapreduce/JobUtil.java

@@ -44,7 +44,7 @@ public abstract class JobUtil {
   /**
    * Initializes the staging directory and returns the path.
    *
-   * @parms conf system configuration
+   * @param conf system configuration
    * @return staging directory path
    * @throws IOException
    * @throws InterruptedException

pom.xml

@@ -393,7 +393,7 @@
             <!--Pass -DskipJavadoc=true or -DskipJavadoc on command-line to skip javadoc building-->
             <skip>${skipJavadoc}</skip>
             <docfilessubdirs>true</docfilessubdirs>
-            <excludePackageNames>org.apache.hadoop.hbase.protobuf.generated.*:org.apache.hadoop.hbase.thrift.generated:org.apache.hadoop.hbase.rest.generated</excludePackageNames>
+            <excludePackageNames>org.junit.*:org.apache.hadoop.metrics2.*:org.apache.hadoop.hbase.protobuf.generated.*:org.apache.hadoop.hbase.thrift.generated:org.apache.hadoop.hbase.rest.generated</excludePackageNames>
             <debug>true</debug>
             <maxmemory>2g</maxmemory>
             <verbose>true</verbose>