HBASE-7363 Fix javadocs warnings for hbase-server packages from master to end; ADDENDUM

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

hbase-server/src/main/java/org/apache/hadoop/hbase/master/GeneralBulkAssigner.java

@@ -38,7 +38,7 @@ import org.apache.hadoop.hbase.ServerName;
 
 /**
  * Run bulk assign.  Does one RCP per regionserver passing a
- * batch of regions using {@link SingleServerBulkAssigner}.
+ * batch of regions using {@link GeneralBulkAssigner.SingleServerBulkAssigner}.
  */
 @InterfaceAudience.Private
 public class GeneralBulkAssigner extends BulkAssigner {

hbase-server/src/main/java/org/apache/hadoop/hbase/master/cleaner/TimeToLiveHFileCleaner.java

@@ -30,7 +30,7 @@ import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;
 
 /**
  * HFile cleaner that uses the timestamp of the hfile to determine if it should be deleted. By
- * default they are allowed to live for {@value TimeToLiveHFileCleaner#DEFAULT_TTL}
+ * default they are allowed to live for {@value #DEFAULT_TTL}
  */
 @InterfaceAudience.Private
 public class TimeToLiveHFileCleaner extends BaseHFileCleanerDelegate {
@@ -38,7 +38,7 @@ public class TimeToLiveHFileCleaner extends BaseHFileCleanerDelegate {
   public static final Log LOG = LogFactory.getLog(TimeToLiveHFileCleaner.class.getName());
   public static final String TTL_CONF_KEY = "hbase.master.hfilecleaner.ttl";
   // default ttl = 5 minutes
-  private static final long DEFAULT_TTL = 60000 * 5;
+  public static final long DEFAULT_TTL = 60000 * 5;
   // Configured time a hfile can be kept after it was moved to the archive
   private long ttl;
   private FileSystem fs;

hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/ProtobufUtil.java

@@ -746,7 +746,7 @@ public final class ProtobufUtil {
    * Create a new protocol buffer Exec based on a client Exec
    *
    * @param exec
-   * @return
+   * @return a ClientProtos.Exec
    * @throws IOException
    */
   public static ClientProtos.Exec toExec(
@@ -1079,7 +1079,7 @@ public final class ProtobufUtil {
    * Convert a delete KeyValue type to protocol buffer DeleteType.
    *
    * @param type
-   * @return
+   * @return a DeleteType
    * @throws IOException
    */
   public static DeleteType toDeleteType(

hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/RequestConverter.java

@@ -1054,9 +1054,10 @@ public final class RequestConverter {
    * @param tableName
    * @return a GetSchemaAlterStatusRequest
    */
-  public static GetSchemaAlterStatusRequest buildGetSchemaAlterStatusRequest(final byte [] table) {
+  public static GetSchemaAlterStatusRequest buildGetSchemaAlterStatusRequest(
+      final byte [] tableName) {
     GetSchemaAlterStatusRequest.Builder builder = GetSchemaAlterStatusRequest.newBuilder();
-    builder.setTableName(ByteString.copyFrom(table));
+    builder.setTableName(ByteString.copyFrom(tableName));
     return builder.build();
   }
 

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegion.java

@@ -1849,7 +1849,7 @@ public class HRegion implements HeapSize { // , Writable{
    * Setup correct timestamps in the KVs in Delete object.
    * Caller should have the row and region locks.
    * @param familyMap
-   * @param now
+   * @param byteNow
    * @throws IOException
    */
   void prepareDeleteTimestamps(Map<byte[], List<KeyValue>> familyMap, byte[] byteNow)
@@ -1990,7 +1990,7 @@ public class HRegion implements HeapSize { // , Writable{
 
   /**
    * Perform a batch put with no pre-specified locks
-   * @see HRegion#put(Pair[])
+   * @see HRegion#batchMutate(Pair[])
    */
   public OperationStatus[] put(Put[] puts) throws IOException {
     @SuppressWarnings("unchecked")

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegionServer.java

@@ -1403,8 +1403,8 @@ public class  HRegionServer implements ClientProtocol,
 
   /**
    * Called by {@link #setupWALAndReplication()} creating WAL instance.
-   * @param logdir
+   * @param rootdir
-   * @param oldLogDir
+   * @param logName
    * @return WAL instance.
    * @throws IOException
    */
@@ -1967,7 +1967,6 @@ public class  HRegionServer implements ClientProtocol,
    * For tests, web ui and metrics.
    * This method will only work if HRegionServer is in the same JVM as client;
    * HRegion cannot be serialized to cross an rpc.
-   * @see #getOnlineRegions()
    */
   public Collection<HRegion> getOnlineRegionsLocalContext() {
     Collection<HRegion> regions = this.onlineRegions.values();
@@ -3723,7 +3722,7 @@ public class  HRegionServer implements ClientProtocol,
    *
    * @param region
    * @param mutate
-   * @return
+   * @return the Result
    * @throws IOException
    */
   protected Result append(final HRegion region,
@@ -3750,7 +3749,7 @@ public class  HRegionServer implements ClientProtocol,
    *
    * @param region
    * @param mutate
-   * @return
+   * @return the Result
    * @throws IOException
    */
   protected Result increment(final HRegion region,

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RegionCoprocessorHost.java

@@ -524,7 +524,7 @@ public class RegionCoprocessorHost
 
   /**
    * See
-   * {@link RegionObserver#preFlush(ObserverContext<RegionCoprocessorEnvironment>, HStore, KeyValueScanner)}
+   * {@link RegionObserver#preFlushScannerOpen(ObserverContext, HStore, KeyValueScanner, InternalScanner)}
    */
   public InternalScanner preFlushScannerOpen(HStore store, KeyValueScanner memstoreScanner) throws IOException {
     ObserverContext<RegionCoprocessorEnvironment> ctx = null;

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RegionSplitPolicy.java

@@ -91,10 +91,9 @@ public abstract class RegionSplitPolicy extends Configured {
 
   /**
    * Create the RegionSplitPolicy configured for the given table.
-   * Each
    * @param region
    * @param conf
-   * @return
+   * @return a RegionSplitPolicy
    * @throws IOException
    */
   public static RegionSplitPolicy create(HRegion region,

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RowProcessor.java

@@ -119,7 +119,7 @@ public interface RowProcessor<S extends Message, T extends Message> {
   /**
    * This method should return any additional data that is needed on the
    * server side to construct the RowProcessor. The server will pass this to
-   * the {@link #initialize(ByteString)} method. If there is no RowProcessor
+   * the {@link #initialize(Message msg)} method. If there is no RowProcessor
    * specific data then null should be returned.
    * @return the PB message
    * @throws IOException

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StoreFileScanner.java

@@ -219,7 +219,7 @@ public class StoreFileScanner implements KeyValueScanner {
    *
    * @param s
    * @param k
-   * @return
+   * @return false if not found or if k is after the end.
    * @throws IOException
    */
   public static boolean seekAtOrAfter(HFileScanner s, KeyValue k)

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/compactions/CompactionRequest.java

@@ -89,7 +89,7 @@ public class CompactionRequest implements Comparable<CompactionRequest>,
      * Find out if a given region is in compaction now.
      *
      * @param regionId
-     * @return
+     * @return a CompactionState
      */
     public static CompactionState getCompactionState(
         final long regionId) {

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/SequenceFileLogWriter.java

@@ -40,7 +40,7 @@ import org.apache.hadoop.io.compress.CompressionCodec;
 import org.apache.hadoop.io.compress.DefaultCodec;
 
 /**
- * Implementation of {@link FSHLog.Writer} that delegates to
+ * Implementation of {@link HLog.Writer} that delegates to
  * SequenceFile.Writer.
  */
 @InterfaceAudience.Private

hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessControlLists.java

@@ -71,11 +71,11 @@ import java.util.*;
  * Key                      Desc
  * --------                 --------
  * user                     table level permissions for a user [R=read, W=write]
- * @group                   table level permissions for a group
+ * group                    table level permissions for a group
  * user,family              column family level permissions for a user
- * @group,family            column family level permissions for a group
+ * group,family             column family level permissions for a group
  * user,family,qualifier    column qualifier level permissions for a user
- * @group,family,qualifier  column qualifier level permissions for a group
+ * group,family,qualifier   column qualifier level permissions for a group
  * </pre>
  * All values are encoded as byte arrays containing the codes from the
  * {@link org.apache.hadoop.hbase.security.access.TablePermission.Action} enum.
@@ -302,7 +302,7 @@ public class AccessControlLists {
    * table.
    *
    * @param aclRegion
-   * @return
+   * @return a map of the permissions for this table.
    * @throws IOException
    */
   static Map<byte[],ListMultimap<String,TablePermission>> loadAll(

hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessControllerProtocol.java

@@ -59,7 +59,7 @@ public interface AccessControllerProtocol extends CoprocessorProtocol {
    * table, column family and column qualifier must all be specified.
    * Attempting to revoke permissions over just the "data" table will have
    * no effect.
-   * @param permission the details of the previously granted permission to revoke
+   * @param userPermission the details of the previously granted permission to revoke
    * @throws IOException if the revocation could not be performed
    */
   public void revoke(UserPermission userPermission)

hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/TableAuthManager.java

@@ -244,7 +244,7 @@ public class TableAuthManager {
    * user's groups.
    * @param user
    * @param action
-   * @return
+   * @return true if known and authorized, false otherwise
    */
   public boolean authorize(User user, Permission.Action action) {
     if (user == null) {
@@ -339,7 +339,7 @@ public class TableAuthManager {
    * @param table
    * @param family
    * @param action
-   * @return
+   * @return true if known and authorized, false otherwise
    */
   public boolean authorizeUser(String username, byte[] table, byte[] family,
       Permission.Action action) {
@@ -372,7 +372,7 @@ public class TableAuthManager {
    * @param table
    * @param family
    * @param action
-   * @return
+   * @return true if known and authorized, false otherwise
    */
   public boolean authorizeGroup(String groupName, byte[] table, byte[] family,
       Permission.Action action) {

hbase-server/src/main/java/org/apache/hadoop/hbase/util/FSUtils.java

@@ -1265,7 +1265,7 @@ public abstract class FSUtils {
    * @param fs
    * @param path
    * @param recursive
-   * @return
+   * @return the value returned by the fs.delete()
    * @throws IOException
    */
   public static boolean delete(final FileSystem fs, final Path path, final boolean recursive)
@@ -1278,7 +1278,7 @@ public abstract class FSUtils {
    * 
    * @param fs
    * @param path
-   * @return
+   * @return the value returned by fs.exists()
    * @throws IOException
    */
   public static boolean isExists(final FileSystem fs, final Path path) throws IOException {

hbase-server/src/main/java/org/apache/hadoop/hbase/zookeeper/RootRegionTracker.java

@@ -28,8 +28,7 @@ import org.apache.zookeeper.KeeperException;
 
 /**
  * Tracks the root region server location node in zookeeper.
- * Root region location is set by {@link RootLocationEditor} usually called
+ * Root region location is set by <code>RegionServerServices</code>.
- * out of <code>RegionServerServices</code>.
  * This class has a watcher on the root location and notices changes.
  */
 @InterfaceAudience.Private

hbase-server/src/main/java/org/apache/hadoop/hbase/zookeeper/ZKTableReadOnly.java

@@ -43,7 +43,7 @@ public class ZKTableReadOnly {
   private ZKTableReadOnly() {}
   
   /**
-   * Go to zookeeper and see if state of table is {@link ZooKeeperProtos.Table.State#DISABLED}.
+   * Go to zookeeper and see if state of table is {@code ZooKeeperProtos.Table.State#DISABLED}.
    * This method does not use cache.
    * This method is for clients other than {@link AssignmentManager}
    * @param zkw
@@ -59,7 +59,7 @@ public class ZKTableReadOnly {
   }
 
   /**
-   * Go to zookeeper and see if state of table is {@link ZooKeeperProtos.Table.State#ENABLED}.
+   * Go to zookeeper and see if state of table is {@code ZooKeeperProtos.Table.State#ENABLED}.
    * This method does not use cache.
    * This method is for clients other than {@link AssignmentManager}
    * @param zkw
@@ -74,8 +74,8 @@ public class ZKTableReadOnly {
   }
 
   /**
-   * Go to zookeeper and see if state of table is {@link ZooKeeperProtos.Table.State#DISABLING}
+   * Go to zookeeper and see if state of table is {@code ZooKeeperProtos.Table.State#DISABLING}
-   * of {@link ZooKeeperProtos.Table.State#DISABLED}.
+   * of {@code ZooKeeperProtos.Table.State#DISABLED}.
    * This method does not use cache.
    * This method is for clients other than {@link AssignmentManager}.
    * @param zkw

pom.xml

@@ -868,7 +868,7 @@
     <jamon.plugin.version>2.3.4</jamon.plugin.version>
     <findbugs.version>2.4.0</findbugs.version>
     <maven.site.version>3.1</maven.site.version>
-    <javadoc.version>2.8.1</javadoc.version>
+    <javadoc.version>2.9</javadoc.version>
     <maven.resources.plugin.version>2.5</maven.resources.plugin.version>
     <!-- General Packaging -->
     <package.prefix>/usr</package.prefix>