HBASE-27220 Apply the spotless format change in HBASE-27208 to our code base

Signed-off-by: Andrew Purtell <apurtell@apache.org>

hbase-asyncfs/src/main/java/org/apache/hadoop/hbase/io/asyncfs/AsyncFSOutput.java

@@ -89,8 +89,6 @@ public interface AsyncFSOutput extends Closeable {
   @Override
   void close() throws IOException;
 
-  /**
+  /** Returns byteSize success synced to underlying filesystem. */
-   * @return byteSize success synced to underlying filesystem.
-   */
   long getSyncedLength();
 }

hbase-asyncfs/src/main/java/org/apache/hadoop/hbase/util/RecoverLeaseFSUtils.java

@@ -186,9 +186,7 @@ public final class RecoverLeaseFSUtils {
     return recovered;
   }
 
-  /**
+  /** Returns Detail to append to any log message around lease recovering. */
-   * @return Detail to append to any log message around lease recovering.
-   */
   private static String getLogMessageDetail(final int nbAttempt, final Path p,
     final long startWaiting) {
     return "attempt=" + nbAttempt + " on file=" + p + " after "

hbase-balancer/src/main/java/org/apache/hadoop/hbase/master/balancer/FavoredStochasticBalancer.java

@@ -87,9 +87,7 @@ public class FavoredStochasticBalancer extends StochasticLoadBalancer
     return fnPickers;
   }
 
-  /**
+  /** Returns any candidate generator in random */
-   * @return any candidate generator in random
-   */
   @Override
   protected CandidateGenerator getRandomGenerator() {
     return candidateGenerators.get(ThreadLocalRandom.current().nextInt(candidateGenerators.size()));

hbase-client/src/main/java/org/apache/hadoop/hbase/CatalogFamilyFormat.java

@@ -398,9 +398,7 @@ public class CatalogFamilyFormat {
     return false;
   }
 
-  /**
+  /** Returns True if the column in <code>cell</code> matches the regex 'info:merge.*'. */
-   * @return True if the column in <code>cell</code> matches the regex 'info:merge.*'.
-   */
   public static boolean isMergeQualifierPrefix(Cell cell) {
     // Check to see if has family and that qualifier starts with the merge qualifier 'merge'
     return CellUtil.matchingFamily(cell, HConstants.CATALOG_FAMILY)

hbase-client/src/main/java/org/apache/hadoop/hbase/ClientMetaTableAccessor.java

@@ -382,9 +382,7 @@ public final class ClientMetaTableAccessor {
 
     abstract void add(Result r);
 
-    /**
+    /** Returns Collected results; wait till visits complete to collect all possible results */
-     * @return Collected results; wait till visits complete to collect all possible results
-     */
     List<T> getResults() {
       return this.results;
     }

hbase-client/src/main/java/org/apache/hadoop/hbase/ClusterId.java

@@ -45,9 +45,7 @@ public class ClusterId {
     this.id = uuid;
   }
 
-  /**
+  /** Returns The clusterid serialized using pb w/ pb magic prefix */
-   * @return The clusterid serialized using pb w/ pb magic prefix
-   */
   public byte[] toByteArray() {
     return ProtobufUtil.prependPBMagic(convert().toByteArray());
   }
@@ -74,9 +72,7 @@ public class ClusterId {
     }
   }
 
-  /**
+  /** Returns A pb instance to represent this instance. */
-   * @return A pb instance to represent this instance.
-   */
   public ClusterIdProtos.ClusterId convert() {
     ClusterIdProtos.ClusterId.Builder builder = ClusterIdProtos.ClusterId.newBuilder();
     return builder.setClusterId(this.id).build();

hbase-client/src/main/java/org/apache/hadoop/hbase/ClusterMetrics.java

@@ -69,38 +69,26 @@ import org.apache.yetus.audience.InterfaceAudience;
 @InterfaceAudience.Public
 public interface ClusterMetrics {
 
-  /**
+  /** Returns the HBase version string as reported by the HMaster */
-   * @return the HBase version string as reported by the HMaster
-   */
   @Nullable
   String getHBaseVersion();
 
-  /**
+  /** Returns the names of region servers on the dead list */
-   * @return the names of region servers on the dead list
-   */
   List<ServerName> getDeadServerNames();
 
-  /**
+  /** Returns the names of region servers on the decommissioned list */
-   * @return the names of region servers on the decommissioned list
-   */
   List<ServerName> getDecommissionedServerNames();
 
-  /**
+  /** Returns the names of region servers on the live list */
-   * @return the names of region servers on the live list
-   */
   Map<ServerName, ServerMetrics> getLiveServerMetrics();
 
-  /**
+  /** Returns the number of regions deployed on the cluster */
-   * @return the number of regions deployed on the cluster
-   */
   default int getRegionCount() {
     return getLiveServerMetrics().entrySet().stream()
       .mapToInt(v -> v.getValue().getRegionMetrics().size()).sum();
   }
 
-  /**
+  /** Returns the number of requests since last report */
-   * @return the number of requests since last report
-   */
   default long getRequestCount() {
     return getLiveServerMetrics().entrySet().stream()
       .flatMap(v -> v.getValue().getRegionMetrics().values().stream())
@@ -114,9 +102,7 @@ public interface ClusterMetrics {
   @Nullable
   ServerName getMasterName();
 
-  /**
+  /** Returns the names of backup masters */
-   * @return the names of backup masters
-   */
   List<ServerName> getBackupMasterNames();
 
   @InterfaceAudience.Private
@@ -147,9 +133,7 @@ public interface ClusterMetrics {
 
   List<ServerName> getServersName();
 
-  /**
+  /** Returns the average cluster load */
-   * @return the average cluster load
-   */
   default double getAverageLoad() {
     int serverSize = getLiveServerMetrics().size();
     if (serverSize == 0) {

hbase-client/src/main/java/org/apache/hadoop/hbase/CoprocessorEnvironment.java

@@ -28,19 +28,19 @@ import org.apache.yetus.audience.InterfaceStability;
 @InterfaceStability.Evolving
 public interface CoprocessorEnvironment<C extends Coprocessor> {
 
-  /** @return the Coprocessor interface version */
+  /** Returns the Coprocessor interface version */
   int getVersion();
 
-  /** @return the HBase version as a string (e.g. "0.21.0") */
+  /** Returns the HBase version as a string (e.g. "0.21.0") */
   String getHBaseVersion();
 
-  /** @return the loaded coprocessor instance */
+  /** Returns the loaded coprocessor instance */
   C getInstance();
 
-  /** @return the priority assigned to the loaded coprocessor */
+  /** Returns the priority assigned to the loaded coprocessor */
   int getPriority();
 
-  /** @return the load sequence number */
+  /** Returns the load sequence number */
   int getLoadSequence();
 
   /**
@@ -49,8 +49,6 @@ public interface CoprocessorEnvironment<C extends Coprocessor> {
    */
   Configuration getConfiguration();
 
-  /**
+  /** Returns the classloader for the loaded coprocessor instance */
-   * @return the classloader for the loaded coprocessor instance
-   */
   ClassLoader getClassLoader();
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/HBaseServerException.java

@@ -63,9 +63,7 @@ public class HBaseServerException extends HBaseIOException {
     this.serverOverloaded = serverOverloaded;
   }
 
-  /**
+  /** Returns True if server was considered overloaded when exception was thrown */
-   * @return True if server was considered overloaded when exception was thrown
-   */
   public boolean isServerOverloaded() {
     return serverOverloaded;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/RegionMetrics.java

@@ -28,44 +28,28 @@ import org.apache.yetus.audience.InterfaceAudience;
 @InterfaceAudience.Public
 public interface RegionMetrics {
 
-  /**
+  /** Returns the region name */
-   * @return the region name
-   */
   byte[] getRegionName();
 
-  /**
+  /** Returns the number of stores */
-   * @return the number of stores
-   */
   int getStoreCount();
 
-  /**
+  /** Returns the number of storefiles */
-   * @return the number of storefiles
-   */
   int getStoreFileCount();
 
-  /**
+  /** Returns the total size of the storefiles */
-   * @return the total size of the storefiles
-   */
   Size getStoreFileSize();
 
-  /**
+  /** Returns the memstore size */
-   * @return the memstore size
-   */
   Size getMemStoreSize();
 
-  /**
+  /** Returns the number of read requests made to region */
-   * @return the number of read requests made to region
-   */
   long getReadRequestCount();
 
-  /**
+  /** Returns the number of write requests made to region */
-   * @return the number of write requests made to region
-   */
   long getWriteRequestCount();
 
-  /**
+  /** Returns the number of coprocessor service requests made to region */
-   * @return the number of coprocessor service requests made to region
-   */
   public long getCpRequestCount();
 
   /**
@@ -76,16 +60,12 @@ public interface RegionMetrics {
     return getReadRequestCount() + getWriteRequestCount() + getCpRequestCount();
   }
 
-  /**
+  /** Returns the region name as a string */
-   * @return the region name as a string
-   */
   default String getNameAsString() {
     return Bytes.toStringBinary(getRegionName());
   }
 
-  /**
+  /** Returns the number of filtered read requests made to region */
-   * @return the number of filtered read requests made to region
-   */
   long getFilteredReadRequestCount();
 
   /**
@@ -96,29 +76,19 @@ public interface RegionMetrics {
    */
   Size getStoreFileIndexSize();
 
-  /**
+  /** Returns The current total size of root-level indexes for the region */
-   * @return The current total size of root-level indexes for the region
-   */
   Size getStoreFileRootLevelIndexSize();
 
-  /**
+  /** Returns The total size of all index blocks, not just the root level */
-   * @return The total size of all index blocks, not just the root level
-   */
   Size getStoreFileUncompressedDataIndexSize();
 
-  /**
+  /** Returns The total size of all Bloom filter blocks, not just loaded into the block cache */
-   * @return The total size of all Bloom filter blocks, not just loaded into the block cache
-   */
   Size getBloomFilterSize();
 
-  /**
+  /** Returns the total number of cells in current compaction */
-   * @return the total number of cells in current compaction
-   */
   long getCompactingCellCount();
 
-  /**
+  /** Returns the number of already compacted kvs in current compaction */
-   * @return the number of already compacted kvs in current compaction
-   */
   long getCompactedCellCount();
 
   /**
@@ -127,29 +97,19 @@ public interface RegionMetrics {
    */
   long getCompletedSequenceId();
 
-  /**
+  /** Returns completed sequence id per store. */
-   * @return completed sequence id per store.
-   */
   Map<byte[], Long> getStoreSequenceId();
 
-  /**
+  /** Returns the uncompressed size of the storefiles */
-   * @return the uncompressed size of the storefiles
-   */
   Size getUncompressedStoreFileSize();
 
-  /**
+  /** Returns the data locality of region in the regionserver. */
-   * @return the data locality of region in the regionserver.
-   */
   float getDataLocality();
 
-  /**
+  /** Returns the timestamp of the oldest hfile for any store of this region. */
-   * @return the timestamp of the oldest hfile for any store of this region.
-   */
   long getLastMajorCompactionTimestamp();
 
-  /**
+  /** Returns the reference count for the stores of this region */
-   * @return the reference count for the stores of this region
-   */
   int getStoreRefCount();
 
   /**
@@ -164,9 +124,7 @@ public interface RegionMetrics {
    */
   float getDataLocalityForSsd();
 
-  /**
+  /** Returns the data at local weight of this region in the regionserver */
-   * @return the data at local weight of this region in the regionserver
-   */
   long getBlocksLocalWeight();
 
   /**
@@ -175,13 +133,9 @@ public interface RegionMetrics {
    */
   long getBlocksLocalWithSsdWeight();
 
-  /**
+  /** Returns the block total weight of this region */
-   * @return the block total weight of this region
-   */
   long getBlocksTotalWeight();
 
-  /**
+  /** Returns the compaction state of this region */
-   * @return the compaction state of this region
-   */
   CompactionState getCompactionState();
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/ServerMetrics.java

@@ -33,48 +33,32 @@ public interface ServerMetrics {
 
   ServerName getServerName();
 
-  /**
+  /** Returns the version number of a regionserver. */
-   * @return the version number of a regionserver.
-   */
   default int getVersionNumber() {
     return 0;
   }
 
-  /**
+  /** Returns the string type version of a regionserver. */
-   * @return the string type version of a regionserver.
-   */
   default String getVersion() {
     return "0.0.0";
   }
 
-  /**
+  /** Returns the number of requests per second. */
-   * @return the number of requests per second.
-   */
   long getRequestCountPerSecond();
 
-  /**
+  /** Returns total Number of requests from the start of the region server. */
-   * @return total Number of requests from the start of the region server.
-   */
   long getRequestCount();
 
-  /**
+  /** Returns total Number of read requests from the start of the region server. */
-   * @return total Number of read requests from the start of the region server.
-   */
   long getReadRequestsCount();
 
-  /**
+  /** Returns total Number of write requests from the start of the region server. */
-   * @return total Number of write requests from the start of the region server.
-   */
   long getWriteRequestsCount();
 
-  /**
+  /** Returns the amount of used heap */
-   * @return the amount of used heap
-   */
   Size getUsedHeapSize();
 
-  /**
+  /** Returns the maximum allowable size of the heap */
-   * @return the maximum allowable size of the heap
-   */
   Size getMaxHeapSize();
 
   int getInfoServerPort();
@@ -97,14 +81,10 @@ public interface ServerMetrics {
   @Nullable
   ReplicationLoadSink getReplicationLoadSink();
 
-  /**
+  /** Returns region load metrics */
-   * @return region load metrics
-   */
   Map<byte[], RegionMetrics> getRegionMetrics();
 
-  /**
+  /** Returns metrics per user */
-   * @return metrics per user
-   */
   Map<byte[], UserMetrics> getUserMetrics();
 
   /**
@@ -113,14 +93,10 @@ public interface ServerMetrics {
    */
   Set<String> getCoprocessorNames();
 
-  /**
+  /** Returns the timestamp (server side) of generating this metrics */
-   * @return the timestamp (server side) of generating this metrics
-   */
   long getReportTimestamp();
 
-  /**
+  /** Returns the last timestamp (server side) of generating this metrics */
-   * @return the last timestamp (server side) of generating this metrics
-   */
   long getLastReportTimestamp();
 
   /**

hbase-client/src/main/java/org/apache/hadoop/hbase/Size.java

@@ -69,9 +69,7 @@ public final class Size implements Comparable<Size> {
     this.unit = Preconditions.checkNotNull(unit);
   }
 
-  /**
+  /** Returns size unit */
-   * @return size unit
-   */
   public Unit getUnit() {
     return unit;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/UserMetrics.java

@@ -40,19 +40,13 @@ public interface UserMetrics {
     long getFilteredReadRequestsCount();
   }
 
-  /**
+  /** Returns the user name */
-   * @return the user name
-   */
   byte[] getUserName();
 
-  /**
+  /** Returns the number of read requests made by user */
-   * @return the number of read requests made by user
-   */
   long getReadRequestCount();
 
-  /**
+  /** Returns the number of write requests made by user */
-   * @return the number of write requests made by user
-   */
   long getWriteRequestCount();
 
   /**
@@ -63,20 +57,14 @@ public interface UserMetrics {
     return getReadRequestCount() + getWriteRequestCount();
   }
 
-  /**
+  /** Returns the user name as a string */
-   * @return the user name as a string
-   */
   default String getNameAsString() {
     return Bytes.toStringBinary(getUserName());
   }
 
-  /**
+  /** Returns metrics per client(hostname) */
-   * @return metrics per client(hostname)
-   */
   Map<String, ClientMetrics> getClientMetrics();
 
-  /**
+  /** Returns count of filtered read requests for a user */
-   * @return count of filtered read requests for a user
-   */
   long getFilteredReadRequests();
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/Admin.java

@@ -111,9 +111,7 @@ public interface Admin extends Abortable, Closeable {
   @Override
   boolean isAborted();
 
-  /**
+  /** Returns Connection used by this object. */
-   * @return Connection used by this object.
-   */
   Connection getConnection();
 
   /**
@@ -1162,9 +1160,7 @@ public interface Admin extends Abortable, Closeable {
   List<RegionMetrics> getRegionMetrics(ServerName serverName, TableName tableName)
     throws IOException;
 
-  /**
+  /** Returns Configuration used by the instance. */
-   * @return Configuration used by the instance.
-   */
   Configuration getConfiguration();
 
   /**

hbase-client/src/main/java/org/apache/hadoop/hbase/client/Append.java

@@ -92,9 +92,7 @@ public class Append extends Mutation {
     return this;
   }
 
-  /**
+  /** Returns current setting for returnResults */
-   * @return current setting for returnResults
-   */
   // This method makes public the superclasses's protected method.
   @Override
   public boolean isReturnResults() {

hbase-client/src/main/java/org/apache/hadoop/hbase/client/AsyncAdmin.java

@@ -1073,34 +1073,24 @@ public interface AsyncAdmin {
   CompletableFuture<Void> recommissionRegionServer(ServerName server,
     List<byte[]> encodedRegionNames);
 
-  /**
+  /** Returns cluster status wrapped by {@link CompletableFuture} */
-   * @return cluster status wrapped by {@link CompletableFuture}
-   */
   CompletableFuture<ClusterMetrics> getClusterMetrics();
 
-  /**
+  /** Returns cluster status wrapped by {@link CompletableFuture} */
-   * @return cluster status wrapped by {@link CompletableFuture}
-   */
   CompletableFuture<ClusterMetrics> getClusterMetrics(EnumSet<Option> options);
 
-  /**
+  /** Returns current master server name wrapped by {@link CompletableFuture} */
-   * @return current master server name wrapped by {@link CompletableFuture}
-   */
   default CompletableFuture<ServerName> getMaster() {
     return getClusterMetrics(EnumSet.of(Option.MASTER)).thenApply(ClusterMetrics::getMasterName);
   }
 
-  /**
+  /** Returns current backup master list wrapped by {@link CompletableFuture} */
-   * @return current backup master list wrapped by {@link CompletableFuture}
-   */
   default CompletableFuture<Collection<ServerName>> getBackupMasters() {
     return getClusterMetrics(EnumSet.of(Option.BACKUP_MASTERS))
       .thenApply(ClusterMetrics::getBackupMasterNames);
   }
 
-  /**
+  /** Returns current live region servers list wrapped by {@link CompletableFuture} */
-   * @return current live region servers list wrapped by {@link CompletableFuture}
-   */
   default CompletableFuture<Collection<ServerName>> getRegionServers() {
     return getClusterMetrics(EnumSet.of(Option.SERVERS_NAME))
       .thenApply(ClusterMetrics::getServersName);
@@ -1132,9 +1122,7 @@ public interface AsyncAdmin {
     return future;
   }
 
-  /**
+  /** Returns a list of master coprocessors wrapped by {@link CompletableFuture} */
-   * @return a list of master coprocessors wrapped by {@link CompletableFuture}
-   */
   default CompletableFuture<List<String>> getMasterCoprocessorNames() {
     return getClusterMetrics(EnumSet.of(Option.MASTER_COPROCESSORS))
       .thenApply(ClusterMetrics::getMasterCoprocessorNames);

hbase-client/src/main/java/org/apache/hadoop/hbase/client/CheckAndMutate.java

@@ -250,66 +250,48 @@ public final class CheckAndMutate implements Row {
     this.action = action;
   }
 
-  /**
+  /** Returns the row */
-   * @return the row
-   */
   @Override
   public byte[] getRow() {
     return row;
   }
 
-  /**
+  /** Returns the family to check */
-   * @return the family to check
-   */
   public byte[] getFamily() {
     return family;
   }
 
-  /**
+  /** Returns the qualifier to check */
-   * @return the qualifier to check
-   */
   public byte[] getQualifier() {
     return qualifier;
   }
 
-  /**
+  /** Returns the comparison operator */
-   * @return the comparison operator
-   */
   public CompareOperator getCompareOp() {
     return op;
   }
 
-  /**
+  /** Returns the expected value */
-   * @return the expected value
-   */
   public byte[] getValue() {
     return value;
   }
 
-  /**
+  /** Returns the filter to check */
-   * @return the filter to check
-   */
   public Filter getFilter() {
     return filter;
   }
 
-  /**
+  /** Returns whether this has a filter or not */
-   * @return whether this has a filter or not
-   */
   public boolean hasFilter() {
     return filter != null;
   }
 
-  /**
+  /** Returns the time range to check */
-   * @return the time range to check
-   */
   public TimeRange getTimeRange() {
     return timeRange;
   }
 
-  /**
+  /** Returns the action done if check succeeds */
-   * @return the action done if check succeeds
-   */
   public Row getAction() {
     return action;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/CheckAndMutateResult.java

@@ -32,16 +32,12 @@ public class CheckAndMutateResult {
     this.result = result;
   }
 
-  /**
+  /** Returns Whether the CheckAndMutate operation is successful or not */
-   * @return Whether the CheckAndMutate operation is successful or not
-   */
   public boolean isSuccess() {
     return success;
   }
 
-  /**
+  /** Returns It is used only for CheckAndMutate operations with Increment/Append. Otherwise null */
-   * @return It is used only for CheckAndMutate operations with Increment/Append. Otherwise null
-   */
   public Result getResult() {
     return result;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/ClientIdGenerator.java

@@ -58,9 +58,7 @@ final class ClientIdGenerator {
     return id;
   }
 
-  /**
+  /** Returns PID of the current process, if it can be extracted from JVM name, or null. */
-   * @return PID of the current process, if it can be extracted from JVM name, or null.
-   */
   public static Long getPid() {
     String name = ManagementFactory.getRuntimeMXBean().getName();
     String[] nameParts = name.split("@");

hbase-client/src/main/java/org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.java

@@ -77,39 +77,25 @@ public interface ColumnFamilyDescriptor {
       return lcf.getConfiguration().hashCode() - rcf.getConfiguration().hashCode();
     };
 
-  /**
+  /** Returns The storefile/hfile blocksize for this column family. */
-   * @return The storefile/hfile blocksize for this column family.
-   */
   int getBlocksize();
 
-  /**
+  /** Returns bloom filter type used for new StoreFiles in ColumnFamily */
-   * @return bloom filter type used for new StoreFiles in ColumnFamily
-   */
   BloomType getBloomFilterType();
 
-  /**
+  /** Returns Compression type setting. */
-   * @return Compression type setting.
-   */
   Compression.Algorithm getCompactionCompressionType();
 
-  /**
+  /** Returns Compression type setting for major compactions. */
-   * @return Compression type setting for major compactions.
-   */
   Compression.Algorithm getMajorCompactionCompressionType();
 
-  /**
+  /** Returns Compression type setting for minor compactions. */
-   * @return Compression type setting for minor compactions.
-   */
   Compression.Algorithm getMinorCompactionCompressionType();
 
-  /**
+  /** Returns Compression type setting. */
-   * @return Compression type setting.
-   */
   Compression.Algorithm getCompressionType();
 
-  /**
+  /** Returns an unmodifiable map. */
-   * @return an unmodifiable map.
-   */
   Map<String, String> getConfiguration();
 
   /**
@@ -118,24 +104,16 @@ public interface ColumnFamilyDescriptor {
    */
   String getConfigurationValue(String key);
 
-  /**
+  /** Returns replication factor set for this CF */
-   * @return replication factor set for this CF
-   */
   short getDFSReplication();
 
-  /**
+  /** Returns the data block encoding algorithm used in block cache and optionally on disk */
-   * @return the data block encoding algorithm used in block cache and optionally on disk
-   */
   DataBlockEncoding getDataBlockEncoding();
 
-  /**
+  /** Returns Return the raw crypto key attribute for the family, or null if not set */
-   * @return Return the raw crypto key attribute for the family, or null if not set
-   */
   byte[] getEncryptionKey();
 
-  /**
+  /** Returns Return the encryption algorithm in use by this family */
-   * @return Return the encryption algorithm in use by this family
-   */
   String getEncryptionType();
 
   /**
@@ -144,19 +122,13 @@ public interface ColumnFamilyDescriptor {
    */
   MemoryCompactionPolicy getInMemoryCompaction();
 
-  /**
+  /** Returns return the KeepDeletedCells */
-   * @return return the KeepDeletedCells
-   */
   KeepDeletedCells getKeepDeletedCells();
 
-  /**
+  /** Returns maximum number of versions */
-   * @return maximum number of versions
-   */
   int getMaxVersions();
 
-  /**
+  /** Returns The minimum number of versions to keep. */
-   * @return The minimum number of versions to keep.
-   */
   int getMinVersions();
 
   /**
@@ -171,19 +143,13 @@ public interface ColumnFamilyDescriptor {
    */
   long getMobThreshold();
 
-  /**
+  /** Returns a copy of Name of this column family */
-   * @return a copy of Name of this column family
-   */
   byte[] getName();
 
-  /**
+  /** Returns Name of this column family */
-   * @return Name of this column family
-   */
   String getNameAsString();
 
-  /**
+  /** Returns the scope tag */
-   * @return the scope tag
-   */
   int getScope();
 
   /**
@@ -193,9 +159,7 @@ public interface ColumnFamilyDescriptor {
    */
   String getStoragePolicy();
 
-  /**
+  /** Returns Time-to-live of cell contents, in seconds. */
-   * @return Time-to-live of cell contents, in seconds.
-   */
   int getTimeToLive();
 
   /**
@@ -228,19 +192,13 @@ public interface ColumnFamilyDescriptor {
    */
   boolean isBlockCacheEnabled();
 
-  /**
+  /** Returns true if we should cache bloomfilter blocks on write */
-   * @return true if we should cache bloomfilter blocks on write
-   */
   boolean isCacheBloomsOnWrite();
 
-  /**
+  /** Returns true if we should cache data blocks on write */
-   * @return true if we should cache data blocks on write
-   */
   boolean isCacheDataOnWrite();
 
-  /**
+  /** Returns true if we should cache index blocks on write */
-   * @return true if we should cache index blocks on write
-   */
   boolean isCacheIndexesOnWrite();
 
   /**
@@ -249,9 +207,7 @@ public interface ColumnFamilyDescriptor {
    */
   boolean isCompressTags();
 
-  /**
+  /** Returns true if we should evict cached blocks from the blockcache on close */
-   * @return true if we should evict cached blocks from the blockcache on close
-   */
   boolean isEvictBlocksOnClose();
 
   /**
@@ -266,14 +222,10 @@ public interface ColumnFamilyDescriptor {
    */
   boolean isMobEnabled();
 
-  /**
+  /** Returns true if we should prefetch blocks into the blockcache on open */
-   * @return true if we should prefetch blocks into the blockcache on open
-   */
   boolean isPrefetchBlocksOnOpen();
 
-  /**
+  /** Returns Column family descriptor with only the customized attributes. */
-   * @return Column family descriptor with only the customized attributes.
-   */
   String toStringCustomizedValues();
 
   /**

hbase-client/src/main/java/org/apache/hadoop/hbase/client/Connection.java

@@ -59,9 +59,7 @@ public interface Connection extends Abortable, Closeable {
    * general methods.
    */
 
-  /**
+  /** Returns Configuration instance being used by this Connection instance. */
-   * @return Configuration instance being used by this Connection instance.
-   */
   Configuration getConfiguration();
 
   /**
@@ -182,9 +180,7 @@ public interface Connection extends Abortable, Closeable {
    */
   AsyncConnection toAsyncConnection();
 
-  /**
+  /** Returns the cluster ID unique to this HBase cluster. */
-   * @return the cluster ID unique to this HBase cluster.
-   */
   String getClusterId();
 
   /**

hbase-client/src/main/java/org/apache/hadoop/hbase/client/ConnectionRegistryFactory.java

@@ -32,9 +32,7 @@ final class ConnectionRegistryFactory {
   private ConnectionRegistryFactory() {
   }
 
-  /**
+  /** Returns The connection registry implementation to use. */
-   * @return The connection registry implementation to use.
-   */
   static ConnectionRegistry getRegistry(Configuration conf) {
     Class<? extends ConnectionRegistry> clazz =
       conf.getClass(CLIENT_CONNECTION_REGISTRY_IMPL_CONF_KEY, RpcConnectionRegistry.class,

hbase-client/src/main/java/org/apache/hadoop/hbase/client/CoprocessorDescriptor.java

@@ -28,23 +28,17 @@ import org.apache.yetus.audience.InterfaceAudience;
  */
 @InterfaceAudience.Public
 public interface CoprocessorDescriptor {
-  /**
+  /** Returns the name of the class or interface represented by this object. */
-   * @return the name of the class or interface represented by this object.
-   */
   String getClassName();
 
   /**
-   * @return Path of the jar file. If it's null, the class will be loaded from default classloader.
+   * Returns Path of the jar file. If it's null, the class will be loaded from default classloader.
    */
   Optional<String> getJarPath();
 
-  /**
+  /** Returns The order to execute this coprocessor */
-   * @return The order to execute this coprocessor
-   */
   int getPriority();
 
-  /**
+  /** Returns Arbitrary key-value parameter pairs passed into the coprocessor. */
-   * @return Arbitrary key-value parameter pairs passed into the coprocessor.
-   */
   Map<String, String> getProperties();
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/Increment.java

@@ -164,9 +164,7 @@ public class Increment extends Mutation {
     return this;
   }
 
-  /**
+  /** Returns current setting for returnResults */
-   * @return current setting for returnResults
-   */
   // This method makes public the superclasses's protected method.
   @Override
   public boolean isReturnResults() {

hbase-client/src/main/java/org/apache/hadoop/hbase/client/MultiResponse.java

@@ -44,9 +44,7 @@ public class MultiResponse extends AbstractResponse {
     super();
   }
 
-  /**
+  /** Returns Number of pairs in this container */
-   * @return Number of pairs in this container
-   */
   public int size() {
     int size = 0;
     for (RegionResult result : results.values()) {
@@ -68,9 +66,7 @@ public class MultiResponse extends AbstractResponse {
     exceptions.put(regionName, ie);
   }
 
-  /**
+  /** Returns the exception for the region, if any. Null otherwise. */
-   * @return the exception for the region, if any. Null otherwise.
-   */
   public Throwable getException(byte[] regionName) {
     return exceptions.get(regionName);
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/MutableRegionInfo.java

@@ -127,14 +127,14 @@ class MutableRegionInfo implements RegionInfo {
   }
 
   /**
-   * @return Return a short, printable name for this region (usually encoded name) for us logging.
+   * Returns Return a short, printable name for this region (usually encoded name) for us logging.
    */
   @Override
   public String getShortNameToLog() {
     return RegionInfo.prettyPrint(this.getEncodedName());
   }
 
-  /** @return the regionId */
+  /** Returns the regionId */
   @Override
   public long getRegionId() {
     return regionId;
@@ -149,15 +149,13 @@ class MutableRegionInfo implements RegionInfo {
     return regionName;
   }
 
-  /**
+  /** Returns Region name as a String for use in logging, etc. */
-   * @return Region name as a String for use in logging, etc.
-   */
   @Override
   public String getRegionNameAsString() {
     return RegionInfo.getRegionNameAsString(this, this.regionName);
   }
 
-  /** @return the encoded region name */
+  /** Returns the encoded region name */
   @Override
   public String getEncodedName() {
     return this.encodedName;
@@ -168,13 +166,13 @@ class MutableRegionInfo implements RegionInfo {
     return this.encodedNameAsBytes;
   }
 
-  /** @return the startKey */
+  /** Returns the startKey */
   @Override
   public byte[] getStartKey() {
     return startKey;
   }
 
-  /** @return the endKey */
+  /** Returns the endKey */
   @Override
   public byte[] getEndKey() {
     return endKey;
@@ -219,15 +217,13 @@ class MutableRegionInfo implements RegionInfo {
         || Bytes.equals(endKey, HConstants.EMPTY_BYTE_ARRAY));
   }
 
-  /** @return true if this region is a meta region */
+  /** Returns true if this region is a meta region */
   @Override
   public boolean isMetaRegion() {
     return tableName.equals(TableName.META_TABLE_NAME);
   }
 
-  /**
+  /** Returns True if has been split and has daughters. */
-   * @return True if has been split and has daughters.
-   */
   @Override
   public boolean isSplit() {
     return this.split;

hbase-client/src/main/java/org/apache/hadoop/hbase/client/Mutation.java

@@ -326,9 +326,7 @@ public abstract class Mutation extends OperationWithAttributes
     return this;
   }
 
-  /**
+  /** Returns the set of clusterIds that have consumed the mutation */
-   * @return the set of clusterIds that have consumed the mutation
-   */
   public List<UUID> getClusterIds() {
     List<UUID> clusterIds = new ArrayList<>();
     byte[] bytes = getAttribute(CONSUMED_CLUSTER_IDS);
@@ -351,9 +349,7 @@ public abstract class Mutation extends OperationWithAttributes
     return this;
   }
 
-  /**
+  /** Returns CellVisibility associated with cells in this Mutation. n */
-   * @return CellVisibility associated with cells in this Mutation. n
-   */
   public CellVisibility getCellVisibility() throws DeserializationException {
     byte[] cellVisibilityBytes = this.getAttribute(VisibilityConstants.VISIBILITY_LABELS_ATTR_KEY);
     if (cellVisibilityBytes == null) return null;
@@ -409,16 +405,12 @@ public abstract class Mutation extends OperationWithAttributes
     return size;
   }
 
-  /**
+  /** Returns the number of different families */
-   * @return the number of different families
-   */
   public int numFamilies() {
     return getFamilyCellMap().size();
   }
 
-  /**
+  /** Returns Calculate what Mutation adds to class heap size. */
-   * @return Calculate what Mutation adds to class heap size.
-   */
   @Override
   public long heapSize() {
     long heapsize = MUTATION_OVERHEAD;
@@ -447,9 +439,7 @@ public abstract class Mutation extends OperationWithAttributes
     return ClassSize.align(heapsize);
   }
 
-  /**
+  /** Returns The serialized ACL for this operation, or null if none */
-   * @return The serialized ACL for this operation, or null if none
-   */
   public byte[] getACL() {
     return getAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL);
   }
@@ -499,9 +489,7 @@ public abstract class Mutation extends OperationWithAttributes
     return this;
   }
 
-  /**
+  /** Returns current value for returnResults */
-   * @return current value for returnResults
-   */
   // Used by Increment and Append only.
   @InterfaceAudience.Private
   protected boolean isReturnResults() {

hbase-client/src/main/java/org/apache/hadoop/hbase/client/NonceGenerator.java

@@ -29,9 +29,9 @@ public interface NonceGenerator {
 
   static final String CLIENT_NONCES_ENABLED_KEY = "hbase.client.nonces.enabled";
 
-  /** @return the nonce group (client ID) of this client manager. */
+  /** Returns the nonce group (client ID) of this client manager. */
   long getNonceGroup();
 
-  /** @return New nonce. */
+  /** Returns New nonce. */
   long newNonce();
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/Query.java

@@ -75,18 +75,14 @@ public abstract class Query extends OperationWithAttributes {
     return this;
   }
 
-  /**
+  /** Returns The authorizations this Query is associated with. n */
-   * @return The authorizations this Query is associated with. n
-   */
   public Authorizations getAuthorizations() throws DeserializationException {
     byte[] authorizationsBytes = this.getAttribute(VisibilityConstants.VISIBILITY_LABELS_ATTR_KEY);
     if (authorizationsBytes == null) return null;
     return ProtobufUtil.toAuthorizations(authorizationsBytes);
   }
 
-  /**
+  /** Returns The serialized ACL for this operation, or null if none */
-   * @return The serialized ACL for this operation, or null if none
-   */
   public byte[] getACL() {
     return getAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL);
   }
@@ -220,9 +216,7 @@ public abstract class Query extends OperationWithAttributes {
     return this;
   }
 
-  /**
+  /** Returns A map of column families to time ranges */
-   * @return A map of column families to time ranges
-   */
   public Map<byte[], TimeRange> getColumnFamilyTimeRange() {
     return this.colFamTimeRangeMap;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/RegionInfo.java

@@ -152,13 +152,11 @@ public interface RegionInfo extends Comparable<RegionInfo> {
   };
 
   /**
-   * @return Return a short, printable name for this region (usually encoded name) for us logging.
+   * Returns Return a short, printable name for this region (usually encoded name) for us logging.
    */
   String getShortNameToLog();
 
-  /**
+  /** Returns the regionId. */
-   * @return the regionId.
-   */
   long getRegionId();
 
   /**
@@ -167,44 +165,28 @@ public interface RegionInfo extends Comparable<RegionInfo> {
    */
   byte[] getRegionName();
 
-  /**
+  /** Returns Region name as a String for use in logging, etc. */
-   * @return Region name as a String for use in logging, etc.
-   */
   String getRegionNameAsString();
 
-  /**
+  /** Returns the encoded region name. */
-   * @return the encoded region name.
-   */
   String getEncodedName();
 
-  /**
+  /** Returns the encoded region name as an array of bytes. */
-   * @return the encoded region name as an array of bytes.
-   */
   byte[] getEncodedNameAsBytes();
 
-  /**
+  /** Returns the startKey. */
-   * @return the startKey.
-   */
   byte[] getStartKey();
 
-  /**
+  /** Returns the endKey. */
-   * @return the endKey.
-   */
   byte[] getEndKey();
 
-  /**
+  /** Returns current table name of the region */
-   * @return current table name of the region
-   */
   TableName getTable();
 
-  /**
+  /** Returns returns region replica id */
-   * @return returns region replica id
-   */
   int getReplicaId();
 
-  /**
+  /** Returns True if has been split and has daughters. */
-   * @return True if has been split and has daughters.
-   */
   boolean isSplit();
 
   /**
@@ -223,9 +205,7 @@ public interface RegionInfo extends Comparable<RegionInfo> {
   @Deprecated
   boolean isSplitParent();
 
-  /**
+  /** Returns true if this region is a meta region. */
-   * @return true if this region is a meta region.
-   */
   boolean isMetaRegion();
 
   /**
@@ -236,9 +216,7 @@ public interface RegionInfo extends Comparable<RegionInfo> {
    */
   boolean containsRange(byte[] rangeStartKey, byte[] rangeEndKey);
 
-  /**
+  /** Returns true if the given row falls in this region. */
-   * @return true if the given row falls in this region.
-   */
   boolean containsRow(byte[] row);
 
   /**
@@ -253,9 +231,7 @@ public interface RegionInfo extends Comparable<RegionInfo> {
       && (regionName[regionName.length - 1] == RegionInfo.ENC_SEPARATOR);
   }
 
-  /**
+  /** Returns the encodedName */
-   * @return the encodedName
-   */
   @InterfaceAudience.Private
   static String encodeRegionName(final byte[] regionName) {
     String encodedName;
@@ -371,7 +347,7 @@ public interface RegionInfo extends Comparable<RegionInfo> {
   }
 
   /**
-   * @return A deserialized {@link RegionInfo} or null if we failed deserialize or passed bytes null
+   * Returns A deserialized {@link RegionInfo} or null if we failed deserialize or passed bytes null
    */
   @InterfaceAudience.Private
   static RegionInfo parseFromOrNull(final byte[] bytes) {
@@ -380,7 +356,7 @@ public interface RegionInfo extends Comparable<RegionInfo> {
   }
 
   /**
-   * @return A deserialized {@link RegionInfo} or null if we failed deserialize or passed bytes null
+   * Returns A deserialized {@link RegionInfo} or null if we failed deserialize or passed bytes null
    */
   @InterfaceAudience.Private
   static RegionInfo parseFromOrNull(final byte[] bytes, int offset, int len) {
@@ -764,16 +740,12 @@ public interface RegionInfo extends Comparable<RegionInfo> {
     return ris;
   }
 
-  /**
+  /** Returns True if this is first Region in Table */
-   * @return True if this is first Region in Table
-   */
   default boolean isFirst() {
     return Bytes.equals(getStartKey(), HConstants.EMPTY_START_ROW);
   }
 
-  /**
+  /** Returns True if this is last Region in Table */
-   * @return True if this is last Region in Table
-   */
   default boolean isLast() {
     return Bytes.equals(getEndKey(), HConstants.EMPTY_END_ROW);
   }
@@ -795,9 +767,7 @@ public interface RegionInfo extends Comparable<RegionInfo> {
     return getTable().equals(other.getTable()) && areAdjacent(this, other);
   }
 
-  /**
+  /** Returns True if RegionInfo is degenerate... if startKey > endKey. */
-   * @return True if RegionInfo is degenerate... if startKey > endKey.
-   */
   default boolean isDegenerate() {
     return !isLast() && Bytes.compareTo(getStartKey(), getEndKey()) > 0;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/RegionReplicaUtil.java

@@ -73,12 +73,12 @@ public class RegionReplicaUtil {
     return getRegionInfoForReplica(regionInfo, DEFAULT_REPLICA_ID);
   }
 
-  /** @return true if this replicaId corresponds to default replica for the region */
+  /** Returns true if this replicaId corresponds to default replica for the region */
   public static boolean isDefaultReplica(int replicaId) {
     return DEFAULT_REPLICA_ID == replicaId;
   }
 
-  /** @return true if this region is a default replica for the region */
+  /** Returns true if this region is a default replica for the region */
   public static boolean isDefaultReplica(RegionInfo hri) {
     return hri.getReplicaId() == DEFAULT_REPLICA_ID;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/RequestController.java

@@ -67,9 +67,7 @@ public interface RequestController {
     void reset() throws InterruptedIOException;
   }
 
-  /**
+  /** Returns A new checker for evaluating a batch rows. */
-   * @return A new checker for evaluating a batch rows.
-   */
   Checker newChecker();
 
   /**
@@ -86,9 +84,7 @@ public interface RequestController {
    */
   void decTaskCounters(Collection<byte[]> regions, ServerName sn);
 
-  /**
+  /** Returns The number of running task. */
-   * @return The number of running task.
-   */
   long getNumberOfTasksInProgress();
 
   /**

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

@@ -671,9 +671,7 @@ public class Result implements CellScannable, CellScanner {
     return this.cells == null || this.cells.length == 0;
   }
 
-  /**
+  /** Returns the size of the underlying Cell [] */
-   * @return the size of the underlying Cell []
-   */
   public int size() {
     return this.cells == null ? 0 : this.cells.length;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/ResultScanner.java

@@ -113,8 +113,6 @@ public interface ResultScanner extends Closeable, Iterable<Result> {
    */
   boolean renewLease();
 
-  /**
+  /** Returns the scan metrics, or {@code null} if we do not enable metrics. */
-   * @return the scan metrics, or {@code null} if we do not enable metrics.
-   */
   ScanMetrics getScanMetrics();
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/Row.java

@@ -28,8 +28,6 @@ import org.apache.yetus.audience.InterfaceAudience;
 public interface Row {
   Comparator<Row> COMPARATOR = (v1, v2) -> Bytes.compareTo(v1.getRow(), v2.getRow());
 
-  /**
+  /** Returns The row. */
-   * @return The row.
-   */
   byte[] getRow();
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/RowAccess.java

@@ -26,13 +26,9 @@ import org.apache.yetus.audience.InterfaceAudience;
  */
 @InterfaceAudience.Private
 public interface RowAccess<T> extends Iterable<T> {
-  /**
+  /** Returns true if there are no elements. */
-   * @return true if there are no elements.
-   */
   boolean isEmpty();
 
-  /**
+  /** Returns the number of elements in this list. */
-   * @return the number of elements in this list.
-   */
   int size();
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/RowMutations.java

@@ -98,9 +98,7 @@ public class RowMutations implements Row {
     return row;
   }
 
-  /**
+  /** Returns An unmodifiable list of the current mutations. */
-   * @return An unmodifiable list of the current mutations.
-   */
   public List<Mutation> getMutations() {
     return Collections.unmodifiableList(mutations);
   }

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

@@ -531,9 +531,7 @@ public class Scan extends Query {
     return this;
   }
 
-  /**
+  /** Returns the maximum result size in bytes. See {@link #setMaxResultSize(long)} */
-   * @return the maximum result size in bytes. See {@link #setMaxResultSize(long)}
-   */
   public long getMaxResultSize() {
     return maxResultSize;
   }
@@ -571,9 +569,7 @@ public class Scan extends Query {
     return this.familyMap;
   }
 
-  /**
+  /** Returns the number of families in familyMap */
-   * @return the number of families in familyMap
-   */
   public int numFamilies() {
     if (hasFamilies()) {
       return this.familyMap.size();
@@ -581,16 +577,12 @@ public class Scan extends Query {
     return 0;
   }
 
-  /**
+  /** Returns true if familyMap is non empty, false otherwise */
-   * @return true if familyMap is non empty, false otherwise
-   */
   public boolean hasFamilies() {
     return !this.familyMap.isEmpty();
   }
 
-  /**
+  /** Returns the keys of the familyMap */
-   * @return the keys of the familyMap
-   */
   public byte[][] getFamilies() {
     if (hasFamilies()) {
       return this.familyMap.keySet().toArray(new byte[0][0]);
@@ -598,51 +590,37 @@ public class Scan extends Query {
     return null;
   }
 
-  /**
+  /** Returns the startrow */
-   * @return the startrow
-   */
   public byte[] getStartRow() {
     return this.startRow;
   }
 
-  /**
+  /** Returns if we should include start row when scan */
-   * @return if we should include start row when scan
-   */
   public boolean includeStartRow() {
     return includeStartRow;
   }
 
-  /**
+  /** Returns the stoprow */
-   * @return the stoprow
-   */
   public byte[] getStopRow() {
     return this.stopRow;
   }
 
-  /**
+  /** Returns if we should include stop row when scan */
-   * @return if we should include stop row when scan
-   */
   public boolean includeStopRow() {
     return includeStopRow;
   }
 
-  /**
+  /** Returns the max number of versions to fetch */
-   * @return the max number of versions to fetch
-   */
   public int getMaxVersions() {
     return this.maxVersions;
   }
 
-  /**
+  /** Returns maximum number of values to return for a single call to next() */
-   * @return maximum number of values to return for a single call to next()
-   */
   public int getBatch() {
     return this.batch;
   }
 
-  /**
+  /** Returns maximum number of values to return per row per CF */
-   * @return maximum number of values to return per row per CF
-   */
   public int getMaxResultsPerColumnFamily() {
     return this.storeLimit;
   }
@@ -655,9 +633,7 @@ public class Scan extends Query {
     return this.storeOffset;
   }
 
-  /**
+  /** Returns caching the number of rows fetched when calling next on a scanner */
-   * @return caching the number of rows fetched when calling next on a scanner
-   */
   public int getCaching() {
     return this.caching;
   }
@@ -677,9 +653,7 @@ public class Scan extends Query {
     return filter;
   }
 
-  /**
+  /** Returns true is a filter has been specified, false if not */
-   * @return true is a filter has been specified, false if not
-   */
   public boolean hasFilter() {
     return filter != null;
   }
@@ -840,9 +814,7 @@ public class Scan extends Query {
     return this;
   }
 
-  /**
+  /** Returns True if this Scan is in "raw" mode. */
-   * @return True if this Scan is in "raw" mode.
-   */
   public boolean isRaw() {
     byte[] attr = getAttribute(RAW_ATTR);
     return attr == null ? false : Bytes.toBoolean(attr);
@@ -902,9 +874,7 @@ public class Scan extends Query {
     return this;
   }
 
-  /**
+  /** Returns True if collection of scan metrics is enabled. For advanced users. */
-   * @return True if collection of scan metrics is enabled. For advanced users.
-   */
   public boolean isScanMetricsEnabled() {
     byte[] attr = getAttribute(Scan.SCAN_ATTRIBUTES_METRICS_ENABLE);
     return attr == null ? false : Bytes.toBoolean(attr);
@@ -924,9 +894,7 @@ public class Scan extends Query {
     return this;
   }
 
-  /**
+  /** Returns the limit of rows for this scan */
-   * @return the limit of rows for this scan
-   */
   public int getLimit() {
     return limit;
   }
@@ -958,9 +926,7 @@ public class Scan extends Query {
     PREAD
   }
 
-  /**
+  /** Returns the read type for this scan */
-   * @return the read type for this scan
-   */
   public ReadType getReadType() {
     return readType;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptor.java

@@ -140,9 +140,7 @@ public interface TableDescriptor {
   // those tables with the highest priority (From Yi Liang over on HBASE-18109).
   int getPriority();
 
-  /**
+  /** Returns Returns the configured replicas per region */
-   * @return Returns the configured replicas per region
-   */
   int getRegionReplication();
 
   /**
@@ -187,9 +185,7 @@ public interface TableDescriptor {
    */
   String getValue(String key);
 
-  /**
+  /** Returns Getter for fetching an unmodifiable map. */
-   * @return Getter for fetching an unmodifiable map.
-   */
   Map<Bytes, Bytes> getValues();
 
   /**
@@ -206,9 +202,7 @@ public interface TableDescriptor {
    */
   boolean hasColumnFamily(final byte[] name);
 
-  /**
+  /** Returns true if the read-replicas memstore replication is enabled. */
-   * @return true if the read-replicas memstore replication is enabled.
-   */
   boolean hasRegionMemStoreReplication();
 
   /**

hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptorBuilder.java

@@ -1058,9 +1058,7 @@ public class TableDescriptorBuilder {
       return families.containsKey(familyName);
     }
 
-    /**
+    /** Returns Name of this table and then a map of all of the column family descriptors. */
-     * @return Name of this table and then a map of all of the column family descriptors.
-     */
     @Override
     public String toString() {
       StringBuilder s = new StringBuilder();
@@ -1083,9 +1081,7 @@ public class TableDescriptorBuilder {
       return s.toString();
     }
 
-    /**
+    /** Returns map of all table attributes formatted into string. */
-     * @return map of all table attributes formatted into string.
-     */
     public String toStringTableAttributes() {
       return getValues(true).toString();
     }
@@ -1195,9 +1191,7 @@ public class TableDescriptorBuilder {
       return false;
     }
 
-    /**
+    /** Returns hash code */
-     * @return hash code
-     */
     @Override
     public int hashCode() {
       int result = this.name.hashCode();
@@ -1245,9 +1239,7 @@ public class TableDescriptorBuilder {
       return setValue(REGION_REPLICATION_KEY, Integer.toString(regionReplication));
     }
 
-    /**
+    /** Returns true if the read-replicas memstore replication is enabled. */
-     * @return true if the read-replicas memstore replication is enabled.
-     */
     @Override
     public boolean hasRegionMemStoreReplication() {
       return getOrDefault(REGION_MEMSTORE_REPLICATION_KEY, Boolean::valueOf,
@@ -1467,9 +1459,7 @@ public class TableDescriptorBuilder {
       }
     }
 
-    /**
+    /** Returns the bytes in pb format */
-     * @return the bytes in pb format
-     */
     private byte[] toByteArray() {
       return ProtobufUtil.prependPBMagic(ProtobufUtil.toTableSchema(this).toByteArray());
     }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableState.java

@@ -94,44 +94,32 @@ public class TableState {
   private final TableName tableName;
   private final State state;
 
-  /**
+  /** Returns True if table is {@link State#ENABLED}. */
-   * @return True if table is {@link State#ENABLED}.
-   */
   public boolean isEnabled() {
     return isInStates(State.ENABLED);
   }
 
-  /**
+  /** Returns True if table is {@link State#ENABLING}. */
-   * @return True if table is {@link State#ENABLING}.
-   */
   public boolean isEnabling() {
     return isInStates(State.ENABLING);
   }
 
-  /**
+  /** Returns True if {@link State#ENABLED} or {@link State#ENABLING} */
-   * @return True if {@link State#ENABLED} or {@link State#ENABLING}
-   */
   public boolean isEnabledOrEnabling() {
     return isInStates(State.ENABLED, State.ENABLING);
   }
 
-  /**
+  /** Returns True if table is disabled. */
-   * @return True if table is disabled.
-   */
   public boolean isDisabled() {
     return isInStates(State.DISABLED);
   }
 
-  /**
+  /** Returns True if table is disabling. */
-   * @return True if table is disabling.
-   */
   public boolean isDisabling() {
     return isInStates(State.DISABLING);
   }
 
-  /**
+  /** Returns True if {@link State#DISABLED} or {@link State#DISABLED} */
-   * @return True if {@link State#DISABLED} or {@link State#DISABLED}
-   */
   public boolean isDisabledOrDisabling() {
     return isInStates(State.DISABLED, State.DISABLING);
   }
@@ -146,9 +134,7 @@ public class TableState {
     this.state = state;
   }
 
-  /**
+  /** Returns table state */
-   * @return table state
-   */
   public State getState() {
     return state;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/client/backoff/ClientBackoffPolicy.java

@@ -32,8 +32,6 @@ public interface ClientBackoffPolicy {
 
   public static final String BACKOFF_POLICY_CLASS = "hbase.client.statistics.backoff-policy";
 
-  /**
+  /** Returns the number of ms to wait on the client based on the */
-   * @return the number of ms to wait on the client based on the
-   */
   public long getBackoffTime(ServerName serverName, byte[] region, ServerStatistics stats);
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/exceptions/PreemptiveFastFailException.java

@@ -67,37 +67,27 @@ public class PreemptiveFastFailException extends ConnectException {
     this.guaranteedClientSideOnly = guaranteedClientSideOnly;
   }
 
-  /**
+  /** Returns time of the fist failure */
-   * @return time of the fist failure
-   */
   public long getFirstFailureAt() {
     return timeOfFirstFailureMilliSec;
   }
 
-  /**
+  /** Returns time of the latest attempt */
-   * @return time of the latest attempt
-   */
   public long getLastAttemptAt() {
     return timeOfLatestAttemptMilliSec;
   }
 
-  /**
+  /** Returns failure count */
-   * @return failure count
-   */
   public long getFailureCount() {
     return failureCount;
   }
 
-  /**
+  /** Returns true if operation was attempted by server, false otherwise. */
-   * @return true if operation was attempted by server, false otherwise.
-   */
   public boolean wasOperationAttemptedByServer() {
     return false;
   }
 
-  /**
+  /** Returns true if we know no mutation made it to the server, false otherwise. */
-   * @return true if we know no mutation made it to the server, false otherwise.
-   */
   public boolean isGuaranteedClientSideOnly() {
     return guaranteedClientSideOnly;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/BigDecimalComparator.java

@@ -72,9 +72,7 @@ public class BigDecimalComparator extends ByteArrayComparable {
     return this.bigDecimal.compareTo(that);
   }
 
-  /**
+  /** Returns The comparator serialized using pb */
-   * @return The comparator serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     ComparatorProtos.BigDecimalComparator.Builder builder =

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/BinaryComparator.java

@@ -54,9 +54,7 @@ public class BinaryComparator extends org.apache.hadoop.hbase.filter.ByteArrayCo
     return ByteBufferUtils.compareTo(this.value, 0, this.value.length, value, offset, length);
   }
 
-  /**
+  /** Returns The comparator serialized using pb */
-   * @return The comparator serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     ComparatorProtos.BinaryComparator.Builder builder =

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/BinaryComponentComparator.java

@@ -75,9 +75,7 @@ public class BinaryComponentComparator extends ByteArrayComparable {
     return result;
   }
 
-  /**
+  /** Returns The comparator serialized using pb */
-   * @return The comparator serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     ComparatorProtos.BinaryComponentComparator.Builder builder =

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/BinaryPrefixComparator.java

@@ -58,9 +58,7 @@ public class BinaryPrefixComparator extends ByteArrayComparable {
     return ByteBufferUtils.compareTo(this.value, 0, this.value.length, value, offset, length);
   }
 
-  /**
+  /** Returns The comparator serialized using pb */
-   * @return The comparator serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     ComparatorProtos.BinaryPrefixComparator.Builder builder =

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/BitComparator.java

@@ -57,16 +57,12 @@ public class BitComparator extends ByteArrayComparable {
     this.bitOperator = bitOperator;
   }
 
-  /**
+  /** Returns the bitwise operator */
-   * @return the bitwise operator
-   */
   public BitwiseOp getOperator() {
     return bitOperator;
   }
 
-  /**
+  /** Returns The comparator serialized using pb */
-   * @return The comparator serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     ComparatorProtos.BitComparator.Builder builder = ComparatorProtos.BitComparator.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.java

@@ -78,9 +78,7 @@ public class ColumnCountGetFilter extends FilterBase {
     return new ColumnCountGetFilter(limit);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.ColumnCountGetFilter.Builder builder =

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.java

@@ -151,9 +151,7 @@ public class ColumnPaginationFilter extends FilterBase {
     return new ColumnPaginationFilter(limit, offset);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.ColumnPaginationFilter.Builder builder =

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.java

@@ -102,9 +102,7 @@ public class ColumnPrefixFilter extends FilterBase {
     return new ColumnPrefixFilter(columnPrefix);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.ColumnPrefixFilter.Builder builder = FilterProtos.ColumnPrefixFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/ColumnRangeFilter.java

@@ -65,44 +65,32 @@ public class ColumnRangeFilter extends FilterBase {
     this.maxColumnInclusive = maxColumnInclusive;
   }
 
-  /**
+  /** Returns if min column range is inclusive. */
-   * @return if min column range is inclusive.
-   */
   public boolean isMinColumnInclusive() {
     return minColumnInclusive;
   }
 
-  /**
+  /** Returns if max column range is inclusive. */
-   * @return if max column range is inclusive.
-   */
   public boolean isMaxColumnInclusive() {
     return maxColumnInclusive;
   }
 
-  /**
+  /** Returns the min column range for the filter */
-   * @return the min column range for the filter
-   */
   public byte[] getMinColumn() {
     return this.minColumn;
   }
 
-  /**
+  /** Returns true if min column is inclusive, false otherwise */
-   * @return true if min column is inclusive, false otherwise
-   */
   public boolean getMinColumnInclusive() {
     return this.minColumnInclusive;
   }
 
-  /**
+  /** Returns the max column range for the filter */
-   * @return the max column range for the filter
-   */
   public byte[] getMaxColumn() {
     return this.maxColumn;
   }
 
-  /**
+  /** Returns true if max column is inclusive, false otherwise */
-   * @return true if max column is inclusive, false otherwise
-   */
   public boolean getMaxColumnInclusive() {
     return this.maxColumnInclusive;
   }
@@ -155,9 +143,7 @@ public class ColumnRangeFilter extends FilterBase {
     return new ColumnRangeFilter(minColumn, minColumnInclusive, maxColumn, maxColumnInclusive);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.ColumnRangeFilter.Builder builder = FilterProtos.ColumnRangeFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/ColumnValueFilter.java

@@ -75,23 +75,17 @@ public class ColumnValueFilter extends FilterBase {
     return op;
   }
 
-  /**
+  /** Returns the comparator */
-   * @return the comparator
-   */
   public ByteArrayComparable getComparator() {
     return comparator;
   }
 
-  /**
+  /** Returns the column family */
-   * @return the column family
-   */
   public byte[] getFamily() {
     return family;
   }
 
-  /**
+  /** Returns the qualifier */
-   * @return the qualifier
-   */
   public byte[] getQualifier() {
     return qualifier;
   }
@@ -161,9 +155,7 @@ public class ColumnValueFilter extends FilterBase {
     return new ColumnValueFilter(family, qualifier, operator, comparator);
   }
 
-  /**
+  /** Returns A pb instance to represent this instance. */
-   * @return A pb instance to represent this instance.
-   */
   FilterProtos.ColumnValueFilter convert() {
     FilterProtos.ColumnValueFilter.Builder builder = FilterProtos.ColumnValueFilter.newBuilder();
 

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/CompareFilter.java

@@ -69,9 +69,7 @@ public abstract class CompareFilter extends FilterBase {
     return op;
   }
 
-  /**
+  /** Returns the comparator */
-   * @return the comparator
-   */
   public ByteArrayComparable getComparator() {
     return comparator;
   }
@@ -158,9 +156,7 @@ public abstract class CompareFilter extends FilterBase {
     return arguments;
   }
 
-  /**
+  /** Returns A pb instance to represent this instance. */
-   * @return A pb instance to represent this instance.
-   */
   FilterProtos.CompareFilter convert() {
     FilterProtos.CompareFilter.Builder builder = FilterProtos.CompareFilter.newBuilder();
     HBaseProtos.CompareType compareOp = CompareType.valueOf(this.op.name());

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/DependentColumnFilter.java

@@ -92,23 +92,17 @@ public class DependentColumnFilter extends CompareFilter {
     this(family, qualifier, dropDependentColumn, CompareOperator.NO_OP, null);
   }
 
-  /**
+  /** Returns the column family */
-   * @return the column family
-   */
   public byte[] getFamily() {
     return this.columnFamily;
   }
 
-  /**
+  /** Returns the column qualifier */
-   * @return the column qualifier
-   */
   public byte[] getQualifier() {
     return this.columnQualifier;
   }
 
-  /**
+  /** Returns true if we should drop the dependent column, false otherwise */
-   * @return true if we should drop the dependent column, false otherwise
-   */
   public boolean dropDependentColumn() {
     return this.dropDependentColumn;
   }
@@ -188,9 +182,7 @@ public class DependentColumnFilter extends CompareFilter {
     }
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.DependentColumnFilter.Builder builder =

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FamilyFilter.java

@@ -73,9 +73,7 @@ public class FamilyFilter extends CompareFilter {
     return new FamilyFilter(compareOp, comparator);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.FamilyFilter.Builder builder = FilterProtos.FamilyFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FilterList.java

@@ -181,9 +181,7 @@ final public class FilterList extends FilterBase {
     return filterListBase.filterRow();
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() throws IOException {
     FilterProtos.FilterList.Builder builder = FilterProtos.FilterList.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.java

@@ -65,9 +65,7 @@ public class FirstKeyOnlyFilter extends FilterBase {
     return new FirstKeyOnlyFilter();
   }
 
-  /**
+  /** Returns true if first KV has been found. */
-   * @return true if first KV has been found.
-   */
   protected boolean hasFoundKV() {
     return this.foundKV;
   }
@@ -79,9 +77,7 @@ public class FirstKeyOnlyFilter extends FilterBase {
     this.foundKV = value;
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.FirstKeyOnlyFilter.Builder builder = FilterProtos.FirstKeyOnlyFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FuzzyRowFilter.java

@@ -251,9 +251,7 @@ public class FuzzyRowFilter extends FilterBase {
     return done;
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.FuzzyRowFilter.Builder builder = FilterProtos.FuzzyRowFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/InclusiveStopFilter.java

@@ -75,9 +75,7 @@ public class InclusiveStopFilter extends FilterBase {
     return new InclusiveStopFilter(stopRowKey);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.InclusiveStopFilter.Builder builder =

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/KeyOnlyFilter.java

@@ -93,9 +93,7 @@ public class KeyOnlyFilter extends FilterBase {
     return filter;
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.KeyOnlyFilter.Builder builder = FilterProtos.KeyOnlyFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/LongComparator.java

@@ -53,9 +53,7 @@ public class LongComparator extends ByteArrayComparable {
     return Long.compare(longValue, that);
   }
 
-  /**
+  /** Returns The comparator serialized using pb */
-   * @return The comparator serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     ComparatorProtos.LongComparator.Builder builder = ComparatorProtos.LongComparator.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.java

@@ -176,9 +176,7 @@ public class MultiRowRangeFilter extends FilterBase {
     return PrivateCellUtil.createFirstOnRow(comparisonData, 0, (short) comparisonData.length);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.MultiRowRangeFilter.Builder builder =
@@ -469,16 +467,12 @@ public class MultiRowRangeFilter extends FilterBase {
       return stopRow;
     }
 
-    /**
+    /** Returns if start row is inclusive. */
-     * @return if start row is inclusive.
-     */
     public boolean isStartRowInclusive() {
       return startRowInclusive;
     }
 
-    /**
+    /** Returns if stop row is inclusive. */
-     * @return if stop row is inclusive.
-     */
     public boolean isStopRowInclusive() {
       return stopRowInclusive;
     }

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/MultipleColumnPrefixFilter.java

@@ -116,9 +116,7 @@ public class MultipleColumnPrefixFilter extends FilterBase {
     return new MultipleColumnPrefixFilter(prefixes);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.MultipleColumnPrefixFilter.Builder builder =

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/NullComparator.java

@@ -63,9 +63,7 @@ public class NullComparator extends ByteArrayComparable {
     return value != null ? 1 : 0;
   }
 
-  /**
+  /** Returns The comparator serialized using pb */
-   * @return The comparator serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     ComparatorProtos.NullComparator.Builder builder = ComparatorProtos.NullComparator.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/PageFilter.java

@@ -91,9 +91,7 @@ public class PageFilter extends FilterBase {
     return new PageFilter(pageSize);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.PageFilter.Builder builder = FilterProtos.PageFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/PrefixFilter.java

@@ -101,9 +101,7 @@ public class PrefixFilter extends FilterBase {
     return new PrefixFilter(prefix);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.PrefixFilter.Builder builder = FilterProtos.PrefixFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/QualifierFilter.java

@@ -67,9 +67,7 @@ public class QualifierFilter extends CompareFilter {
     return new QualifierFilter(compareOp, comparator);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.QualifierFilter.Builder builder = FilterProtos.QualifierFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/RandomRowFilter.java

@@ -43,9 +43,7 @@ public class RandomRowFilter extends FilterBase {
     this.chance = chance;
   }
 
-  /**
+  /** Returns The chance that a row gets included. */
-   * @return The chance that a row gets included.
-   */
   public float getChance() {
     return chance;
   }
@@ -100,9 +98,7 @@ public class RandomRowFilter extends FilterBase {
     filterOutRow = false;
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.RandomRowFilter.Builder builder = FilterProtos.RandomRowFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/RegexStringComparator.java

@@ -145,9 +145,7 @@ public class RegexStringComparator extends ByteArrayComparable {
     return engine.compareTo(value, offset, length);
   }
 
-  /**
+  /** Returns The comparator serialized using pb */
-   * @return The comparator serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     return engine.toByteArray();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/RowFilter.java

@@ -87,9 +87,7 @@ public class RowFilter extends CompareFilter {
     return new RowFilter(compareOp, comparator);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.RowFilter.Builder builder = FilterProtos.RowFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/SingleColumnValueExcludeFilter.java

@@ -112,9 +112,7 @@ public class SingleColumnValueExcludeFilter extends SingleColumnValueFilter {
     return filter;
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.SingleColumnValueExcludeFilter.Builder builder =

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.java

@@ -125,23 +125,17 @@ public class SingleColumnValueFilter extends FilterBase {
     return op;
   }
 
-  /**
+  /** Returns the comparator */
-   * @return the comparator
-   */
   public org.apache.hadoop.hbase.filter.ByteArrayComparable getComparator() {
     return comparator;
   }
 
-  /**
+  /** Returns the family */
-   * @return the family
-   */
   public byte[] getFamily() {
     return columnFamily;
   }
 
-  /**
+  /** Returns the qualifier */
-   * @return the qualifier
-   */
   public byte[] getQualifier() {
     return columnQualifier;
   }
@@ -283,9 +277,7 @@ public class SingleColumnValueFilter extends FilterBase {
     return builder.build();
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     return convert().toByteArray();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/SkipFilter.java

@@ -96,9 +96,7 @@ public class SkipFilter extends FilterBase {
     return true;
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() throws IOException {
     FilterProtos.SkipFilter.Builder builder = FilterProtos.SkipFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/SubstringComparator.java

@@ -66,9 +66,7 @@ public class SubstringComparator extends ByteArrayComparable {
     return Bytes.toString(value, offset, length).toLowerCase(Locale.ROOT).contains(substr) ? 0 : 1;
   }
 
-  /**
+  /** Returns The comparator serialized using pb */
-   * @return The comparator serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     ComparatorProtos.SubstringComparator.Builder builder =

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/TimestampsFilter.java

@@ -77,9 +77,7 @@ public class TimestampsFilter extends FilterBase {
     init();
   }
 
-  /**
+  /** Returns the list of timestamps */
-   * @return the list of timestamps
-   */
   public List<Long> getTimestamps() {
     List<Long> list = new ArrayList<>(timestamps.size());
     list.addAll(timestamps);
@@ -159,9 +157,7 @@ public class TimestampsFilter extends FilterBase {
     return new TimestampsFilter(timestamps);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.TimestampsFilter.Builder builder = FilterProtos.TimestampsFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/ValueFilter.java

@@ -69,9 +69,7 @@ public class ValueFilter extends CompareFilter {
     return new ValueFilter(compareOp, comparator);
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() {
     FilterProtos.ValueFilter.Builder builder = FilterProtos.ValueFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/filter/WhileMatchFilter.java

@@ -94,9 +94,7 @@ public class WhileMatchFilter extends FilterBase {
     return true;
   }
 
-  /**
+  /** Returns The filter serialized using pb */
-   * @return The filter serialized using pb
-   */
   @Override
   public byte[] toByteArray() throws IOException {
     FilterProtos.WhileMatchFilter.Builder builder = FilterProtos.WhileMatchFilter.newBuilder();

hbase-client/src/main/java/org/apache/hadoop/hbase/ipc/HBaseRpcController.java

@@ -60,9 +60,7 @@ public interface HBaseRpcController extends RpcController, CellScannable {
    */
   void setPriority(final TableName tn);
 
-  /**
+  /** Returns The priority of this request */
-   * @return The priority of this request
-   */
   int getPriority();
 
   int getCallTimeout();
@@ -110,16 +108,12 @@ public interface HBaseRpcController extends RpcController, CellScannable {
    */
   void notifyOnCancel(RpcCallback<Object> callback, CancellationCallback action) throws IOException;
 
-  /**
+  /** Returns True if this Controller is carrying the RPC target Region's RegionInfo. */
-   * @return True if this Controller is carrying the RPC target Region's RegionInfo.
-   */
   default boolean hasRegionInfo() {
     return false;
   }
 
-  /**
+  /** Returns Target Region's RegionInfo or null if not available or pertinent. */
-   * @return Target Region's RegionInfo or null if not available or pertinent.
-   */
   default RegionInfo getRegionInfo() {
     return null;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.java

@@ -101,9 +101,7 @@ public class HBaseRpcControllerImpl implements HBaseRpcController {
     return this.regionInfo;
   }
 
-  /**
+  /** Returns One-shot cell scanner (you cannot back it up and restart) */
-   * @return One-shot cell scanner (you cannot back it up and restart)
-   */
   @Override
   public CellScanner cellScanner() {
     return cellScanner;

hbase-client/src/main/java/org/apache/hadoop/hbase/ipc/IPCUtil.java

@@ -96,9 +96,7 @@ class IPCUtil {
     return totalSize;
   }
 
-  /**
+  /** Returns Size on the wire when the two messages are written with writeDelimitedTo */
-   * @return Size on the wire when the two messages are written with writeDelimitedTo
-   */
   public static int getTotalSizeWhenWrittenDelimited(Message... messages) {
     int totalSize = 0;
     for (Message m : messages) {
@@ -149,9 +147,7 @@ class IPCUtil {
         serverOverloaded);
   }
 
-  /**
+  /** Returns True if the exception is a fatal connection exception. */
-   * @return True if the exception is a fatal connection exception.
-   */
   static boolean isFatalConnectionException(final ExceptionResponse e) {
     return e.getExceptionClassName().equals(FatalConnectionException.class.getName());
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/ipc/RemoteWithExtrasException.java

@@ -123,30 +123,22 @@ public class RemoteWithExtrasException extends RemoteException {
     return ex;
   }
 
-  /**
+  /** Returns null if not set */
-   * @return null if not set
-   */
   public String getHostname() {
     return this.hostname;
   }
 
-  /**
+  /** Returns -1 if not set */
-   * @return -1 if not set
-   */
   public int getPort() {
     return this.port;
   }
 
-  /**
+  /** Returns True if origin exception was a do not retry type. */
-   * @return True if origin exception was a do not retry type.
-   */
   public boolean isDoNotRetry() {
     return this.doNotRetry;
   }
 
-  /**
+  /** Returns True if the server was considered overloaded when the exception was thrown. */
-   * @return True if the server was considered overloaded when the exception was thrown.
-   */
   public boolean isServerOverloaded() {
     return serverOverloaded;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/protobuf/ProtobufMagic.java

@@ -77,9 +77,7 @@ public class ProtobufMagic {
     return compareTo(PB_MAGIC, 0, PB_MAGIC.length, bytes, offset, PB_MAGIC.length) == 0;
   }
 
-  /**
+  /** Returns Length of {@link #PB_MAGIC} */
-   * @return Length of {@link #PB_MAGIC}
-   */
   public static int lengthOfPBMagic() {
     return PB_MAGIC.length;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/quotas/QuotaFilter.java

@@ -92,32 +92,32 @@ public class QuotaFilter {
     return this;
   }
 
-  /** @return true if the filter is empty */
+  /** Returns true if the filter is empty */
   public boolean isNull() {
     return !hasFilters;
   }
 
-  /** @return the QuotaType types that we want to filter one */
+  /** Returns the QuotaType types that we want to filter one */
   public Set<QuotaType> getTypeFilters() {
     return types;
   }
 
-  /** @return the Namespace filter regex */
+  /** Returns the Namespace filter regex */
   public String getNamespaceFilter() {
     return namespaceRegex;
   }
 
-  /** @return the Table filter regex */
+  /** Returns the Table filter regex */
   public String getTableFilter() {
     return tableRegex;
   }
 
-  /** @return the User filter regex */
+  /** Returns the User filter regex */
   public String getUserFilter() {
     return userRegex;
   }
 
-  /** @return the RegionServer filter regex */
+  /** Returns the RegionServer filter regex */
   public String getRegionServerFilter() {
     return regionServerRegex;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/quotas/SpaceQuotaSnapshot.java

@@ -74,9 +74,7 @@ public class SpaceQuotaSnapshot implements SpaceQuotaSnapshotView {
       return policy;
     }
 
-    /**
+    /** Returns {@code true} if the quota is being violated, {@code false} otherwise. */
-     * @return {@code true} if the quota is being violated, {@code false} otherwise.
-     */
     @Override
     public boolean isInViolation() {
       return inViolation;

hbase-client/src/main/java/org/apache/hadoop/hbase/quotas/SpaceQuotaSnapshotView.java

@@ -39,9 +39,7 @@ public interface SpaceQuotaSnapshotView {
      */
     Optional<SpaceViolationPolicy> getPolicy();
 
-    /**
+    /** Returns {@code true} if the quota is being violated, {@code false} otherwise. */
-     * @return {@code true} if the quota is being violated, {@code false} otherwise.
-     */
     boolean isInViolation();
   }
 

hbase-client/src/main/java/org/apache/hadoop/hbase/security/access/Permission.java

@@ -203,7 +203,7 @@ public class Permission extends VersionedWritable {
     return raw.toString();
   }
 
-  /** @return the object version number */
+  /** Returns the object version number */
   @Override
   public byte getVersion() {
     return VERSION;

hbase-client/src/main/java/org/apache/hadoop/hbase/security/visibility/CellVisibility.java

@@ -35,9 +35,7 @@ public class CellVisibility {
     this.expression = expression;
   }
 
-  /**
+  /** Returns The visibility expression */
-   * @return The visibility expression
-   */
   public String getExpression() {
     return this.expression;
   }

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

@@ -339,9 +339,7 @@ public final class ProtobufUtil {
     }
   }
 
-  /**
+  /** Returns Length of {@link ProtobufMagic#lengthOfPBMagic()} */
-   * @return Length of {@link ProtobufMagic#lengthOfPBMagic()}
-   */
   public static int lengthOfPBMagic() {
     return ProtobufMagic.lengthOfPBMagic();
   }
@@ -1689,9 +1687,7 @@ public final class ProtobufUtil {
     }
   }
 
-  /**
+  /** Returns A GetRegionInfoRequest for the passed in regionName. */
-   * @return A GetRegionInfoRequest for the passed in regionName.
-   */
   public static GetRegionInfoRequest getGetRegionInfoRequest(final byte[] regionName)
     throws IOException {
     return org.apache.hadoop.hbase.client.RegionInfo.isEncodedRegionName(regionName)

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

@@ -645,9 +645,7 @@ public final class RequestConverter {
       ProtobufUtil.toMutationNoData(MutationType.APPEND, append, mutationBuilder, nonce)));
   }
 
-  /**
+  /** Returns whether or not the rowMutations has a Increment or Append */
-   * @return whether or not the rowMutations has a Increment or Append
-   */
   private static boolean buildNoDataRegionAction(final RowMutations rowMutations,
     final List<CellScannable> cells, long nonce, final RegionAction.Builder regionActionBuilder,
     final ClientProtos.Action.Builder actionBuilder, final MutationProto.Builder mutationBuilder)

hbase-client/src/main/java/org/apache/hadoop/hbase/snapshot/HBaseSnapshotException.java

@@ -69,9 +69,7 @@ public class HBaseSnapshotException extends DoNotRetryIOException {
     super(message, cause);
   }
 
-  /**
+  /** Returns the description of the snapshot that is being failed */
-   * @return the description of the snapshot that is being failed
-   */
   public SnapshotDescription getSnapshotDescription() {
     return this.description;
   }

hbase-client/src/main/java/org/apache/hadoop/hbase/zookeeper/ZNodePaths.java

@@ -133,9 +133,7 @@ public class ZNodePaths {
       .append(snapshotCleanupZNode).append("]").toString();
   }
 
-  /**
+  /** Returns the znode string corresponding to a replicaId */
-   * @return the znode string corresponding to a replicaId
-   */
   public String getZNodeForReplica(int replicaId) {
     if (RegionReplicaUtil.isDefaultReplica(replicaId)) {
       return joinZNode(baseZNode, metaZNodePrefix);
@@ -165,16 +163,12 @@ public class ZNodePaths {
       : Integer.parseInt(znode.substring(metaZNodePrefix.length() + 1));
   }
 
-  /**
+  /** Returns True if meta znode. */
-   * @return True if meta znode.
-   */
   public boolean isMetaZNodePrefix(String znode) {
     return znode != null && znode.startsWith(this.metaZNodePrefix);
   }
 
-  /**
+  /** Returns True is the fully qualified path is for meta location */
-   * @return True is the fully qualified path is for meta location
-   */
   public boolean isMetaZNodePath(String path) {
     int prefixLen = baseZNode.length() + 1;
     return path.length() > prefixLen && isMetaZNodePrefix(path.substring(prefixLen));

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

@@ -91,33 +91,25 @@ public class ArrayBackedTag implements Tag {
     this.type = bytes[offset + TAG_LENGTH_SIZE];
   }
 
-  /**
+  /** Returns The byte array backing this Tag. */
-   * @return The byte array backing this Tag.
-   */
   @Override
   public byte[] getValueArray() {
     return this.bytes;
   }
 
-  /**
+  /** Returns the tag type */
-   * @return the tag type
-   */
   @Override
   public byte getType() {
     return this.type;
   }
 
-  /**
+  /** Returns Length of actual tag bytes within the backed buffer */
-   * @return Length of actual tag bytes within the backed buffer
-   */
   @Override
   public int getValueLength() {
     return this.length - INFRASTRUCTURE_SIZE;
   }
 
-  /**
+  /** Returns Offset of actual tag bytes within the backed buffer */
-   * @return Offset of actual tag bytes within the backed buffer
-   */
   @Override
   public int getValueOffset() {
     return this.offset + INFRASTRUCTURE_SIZE;

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

@@ -60,53 +60,33 @@ import org.apache.yetus.audience.InterfaceAudience;
  */
 @InterfaceAudience.Private
 public abstract class ByteBufferExtendedCell implements ExtendedCell {
-  /**
+  /** Returns The {@link ByteBuffer} containing the row bytes. */
-   * @return The {@link ByteBuffer} containing the row bytes.
-   */
   public abstract ByteBuffer getRowByteBuffer();
 
-  /**
+  /** Returns Position in the {@link ByteBuffer} where row bytes start */
-   * @return Position in the {@link ByteBuffer} where row bytes start
-   */
   public abstract int getRowPosition();
 
-  /**
+  /** Returns The {@link ByteBuffer} containing the column family bytes. */
-   * @return The {@link ByteBuffer} containing the column family bytes.
-   */
   public abstract ByteBuffer getFamilyByteBuffer();
 
-  /**
+  /** Returns Position in the {@link ByteBuffer} where column family bytes start */
-   * @return Position in the {@link ByteBuffer} where column family bytes start
-   */
   public abstract int getFamilyPosition();
 
-  /**
+  /** Returns The {@link ByteBuffer} containing the column qualifier bytes. */
-   * @return The {@link ByteBuffer} containing the column qualifier bytes.
-   */
   public abstract ByteBuffer getQualifierByteBuffer();
 
-  /**
+  /** Returns Position in the {@link ByteBuffer} where column qualifier bytes start */
-   * @return Position in the {@link ByteBuffer} where column qualifier bytes start
-   */
   public abstract int getQualifierPosition();
 
-  /**
+  /** Returns The {@link ByteBuffer} containing the value bytes. */
-   * @return The {@link ByteBuffer} containing the value bytes.
-   */
   public abstract ByteBuffer getValueByteBuffer();
 
-  /**
+  /** Returns Position in the {@link ByteBuffer} where value bytes start */
-   * @return Position in the {@link ByteBuffer} where value bytes start
-   */
   public abstract int getValuePosition();
 
-  /**
+  /** Returns The {@link ByteBuffer} containing the tag bytes. */
-   * @return The {@link ByteBuffer} containing the tag bytes.
-   */
   public abstract ByteBuffer getTagsByteBuffer();
 
-  /**
+  /** Returns Position in the {@link ByteBuffer} where tag bytes start */
-   * @return Position in the {@link ByteBuffer} where tag bytes start
-   */
   public abstract int getTagsPosition();
 }

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

@@ -68,14 +68,10 @@ public interface Cell extends HeapSize {
    */
   byte[] getRowArray();
 
-  /**
+  /** Returns Array index of first row byte */
-   * @return Array index of first row byte
-   */
   int getRowOffset();
 
-  /**
+  /** Returns Number of row bytes. Must be < rowArray.length - offset. */
-   * @return Number of row bytes. Must be < rowArray.length - offset.
-   */
   short getRowLength();
 
   // 2) Family
@@ -87,14 +83,10 @@ public interface Cell extends HeapSize {
    */
   byte[] getFamilyArray();
 
-  /**
+  /** Returns Array index of first family byte */
-   * @return Array index of first family byte
-   */
   int getFamilyOffset();
 
-  /**
+  /** Returns Number of family bytes. Must be < familyArray.length - offset. */
-   * @return Number of family bytes. Must be < familyArray.length - offset.
-   */
   byte getFamilyLength();
 
   // 3) Qualifier
@@ -105,14 +97,10 @@ public interface Cell extends HeapSize {
    */
   byte[] getQualifierArray();
 
-  /**
+  /** Returns Array index of first qualifier byte */
-   * @return Array index of first qualifier byte
-   */
   int getQualifierOffset();
 
-  /**
+  /** Returns Number of qualifier bytes. Must be < qualifierArray.length - offset. */
-   * @return Number of qualifier bytes. Must be < qualifierArray.length - offset.
-   */
   int getQualifierLength();
 
   // 4) Timestamp
@@ -154,19 +142,13 @@ public interface Cell extends HeapSize {
    */
   byte[] getValueArray();
 
-  /**
+  /** Returns Array index of first value byte */
-   * @return Array index of first value byte
-   */
   int getValueOffset();
 
-  /**
+  /** Returns Number of value bytes. Must be < valueArray.length - offset. */
-   * @return Number of value bytes. Must be < valueArray.length - offset.
-   */
   int getValueLength();
 
-  /**
+  /** Returns Serialized size (defaults to include tag length if has some tags). */
-   * @return Serialized size (defaults to include tag length if has some tags).
-   */
   int getSerializedSize();
 
   /**

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

@@ -26,8 +26,6 @@ import org.apache.yetus.audience.InterfaceAudience;
  */
 @InterfaceAudience.Public
 public interface CellScannable {
-  /**
+  /** Returns A CellScanner over the contained {@link Cell}s */
-   * @return A CellScanner over the contained {@link Cell}s
-   */
   CellScanner cellScanner();
 }

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

@@ -47,9 +47,7 @@ import org.apache.yetus.audience.InterfaceAudience;
  */
 @InterfaceAudience.Public
 public interface CellScanner {
-  /**
+  /** Returns the current Cell which may be mutable */
-   * @return the current Cell which may be mutable
-   */
   Cell current();
 
   /**

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

@@ -501,9 +501,7 @@ public final class CellUtil {
     return matchingFamily(left, fam) && matchingQualifier(left, qual);
   }
 
-  /**
+  /** Returns True if matching column family and the qualifier starts with <code>qual</code> */
-   * @return True if matching column family and the qualifier starts with <code>qual</code>
-   */
   public static boolean matchingColumnFamilyAndQualifierPrefix(final Cell left, final byte[] fam,
     final byte[] qual) {
     return matchingFamily(left, fam) && PrivateCellUtil.qualifierStartsWith(left, qual);
@@ -571,9 +569,7 @@ public final class CellUtil {
     return PrivateCellUtil.isDelete(cell.getTypeByte());
   }
 
-  /**
+  /** Returns True if this cell is a Put. */
-   * @return True if this cell is a Put.
-   */
   @SuppressWarnings("deprecation")
   public static boolean isPut(Cell cell) {
     return cell.getTypeByte() == Type.Put.getCode();
@@ -600,9 +596,7 @@ public final class CellUtil {
     PrivateCellUtil.setTimestamp(cell, Bytes.toLong(ts, tsOffset));
   }
 
-  /**
+  /** Returns The Key portion of the passed <code>cell</code> as a String. */
-   * @return The Key portion of the passed <code>cell</code> as a String.
-   */
   public static String getCellKeyAsString(Cell cell) {
     return getCellKeyAsString(cell,
       c -> Bytes.toStringBinary(c.getRowArray(), c.getRowOffset(), c.getRowLength()));

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

@@ -228,9 +228,7 @@ public class ChoreService {
     }
   }
 
-  /**
+  /** Returns true when the chore is scheduled with the implementer of this interface */
-   * @return true when the chore is scheduled with the implementer of this interface
-   */
   @InterfaceAudience.Private
   public synchronized boolean isChoreScheduled(ScheduledChore chore) {
     return chore != null && scheduledChores.containsKey(chore)
@@ -248,9 +246,7 @@ public class ChoreService {
     rescheduleChore(chore);
   }
 
-  /**
+  /** Returns number of chores that this service currently has scheduled */
-   * @return number of chores that this service currently has scheduled
-   */
   int getNumberOfScheduledChores() {
     return scheduledChores.size();
   }
@@ -263,9 +259,7 @@ public class ChoreService {
     return choresMissingStartTime.size();
   }
 
-  /**
+  /** Returns number of threads in the core pool of the underlying ScheduledThreadPoolExecutor */
-   * @return number of threads in the core pool of the underlying ScheduledThreadPoolExecutor
-   */
   int getCorePoolSize() {
     return scheduler.getCorePoolSize();
   }
@@ -375,16 +369,12 @@ public class ChoreService {
     choresMissingStartTime.clear();
   }
 
-  /**
+  /** Returns true when the service is shutdown and thus cannot be used anymore */
-   * @return true when the service is shutdown and thus cannot be used anymore
-   */
   public boolean isShutdown() {
     return scheduler.isShutdown();
   }
 
-  /**
+  /** Returns true when the service is shutdown and all threads have terminated */
-   * @return true when the service is shutdown and all threads have terminated
-   */
   public boolean isTerminated() {
     return scheduler.isTerminated();
   }

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

@@ -86,9 +86,7 @@ public interface ExtendedCell extends RawCell, HeapSize {
       getValueLength(), getTagsLength(), withTags);
   }
 
-  /**
+  /** Returns Serialized size (defaults to include tag length). */
-   * @return Serialized size (defaults to include tag length).
-   */
   @Override
   default int getSerializedSize() {
     return getSerializedSize(true);
@@ -155,9 +153,7 @@ public interface ExtendedCell extends RawCell, HeapSize {
    */
   byte[] getTagsArray();
 
-  /**
+  /** Returns the first offset where the tags start in the Cell */
-   * @return the first offset where the tags start in the Cell
-   */
   int getTagsOffset();
 
   /**
@@ -170,8 +166,6 @@ public interface ExtendedCell extends RawCell, HeapSize {
    */
   int getTagsLength();
 
-  /**
+  /** Returns The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc */
-   * @return The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
-   */
   byte getTypeByte();
 }