HBASE-22571 changes made according to comments by Jan

Author: murtazahassan123

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

@@ -434,7 +434,7 @@ private void waitForRegion() throws InterruptedIOException {
      *
      * @param loc
      * @param heapSizeOfRow
-     * @return either Include ReturnCode or Skip ReturnCode
+     * @return either Include {@link ReturnCode} or Skip {@link ReturnCode}
      */
     @Override
     public ReturnCode canTakeOperation(HRegionLocation loc, long heapSizeOfRow) {

hbase-mapreduce/src/test/java/org/apache/hadoop/hbase/mapred/TestTableInputFormat.java

@@ -147,7 +147,8 @@ public static Table createTable(byte[] tableName, byte[][] families) throws IOEx
    * @param key
    * @param expectedKey
    * @param expectedValue
-   * @return true if succeed
+   * @return true if result and key have expected values, false otherwise. Where result is a single
+   *         row result.
    */
   static boolean checkResult(Result r, ImmutableBytesWritable key,
       byte[] expectedKey, byte[] expectedValue) {

hbase-mapreduce/src/test/java/org/apache/hadoop/hbase/mapreduce/TestTableInputFormat.java

@@ -145,7 +145,8 @@ public static Table createTable(byte[] tableName, byte[][] families) throws IOEx
    * @param key
    * @param expectedKey
    * @param expectedValue
-   * @return true if succeed
+   * @return true if result and key have expected values, false otherwise. Where result is a single
+   *         row result.
    */
   static boolean checkResult(Result r, ImmutableBytesWritable key,
       byte[] expectedKey, byte[] expectedValue) {

hbase-server/src/main/java/org/apache/hadoop/hbase/client/locking/EntityLock.java

@@ -218,7 +218,7 @@ public LockHeartbeatWorker(final String desc) {
     }
 
     /**
-     * @return Shutdown the thread cleanly, quietly. We done.
+     * @return Shuts down the thread clean and quietly.
      */
     Thread shutdown() {
       shutdown = true;

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

@@ -4090,7 +4090,7 @@ OperationStatus[] batchMutate(BatchOperation<?> batchOp) throws IOException {
   /**
    * Called to do a piece of the batch that came in to {@link #batchMutate(Mutation[], long, long)}
    * In here we also handle replay of edits on region recover. Also gets change in size brought
-   * about by applying <code>batchOp</code>
+   * about by applying {@code batchOp}.
    */
   private void doMiniBatchMutate(BatchOperation<?> batchOp) throws IOException {
     boolean success = false;

hbase-server/src/test/java/org/apache/hadoop/hbase/TestServerSideScanMetricsFromClientSide.java

@@ -109,12 +109,12 @@ public static void tearDownAfterClass() throws Exception {
 
   /**
    * Make puts to put the input value into each combination of row, family, and qualifier
-   * @param rows
-   * @param families
-   * @param qualifiers
-   * @param value
-   * @return the putted values added in puts
-   * @throws IOException
+   * @param rows the rows to use
+   * @param families the column families to use
+   * @param qualifiers the column qualifiers to use
+   * @param value the value to put
+   * @return the putted input values added in puts
+   * @throws IOException If IO problem is encountered
    */
   static ArrayList<Put> createPuts(byte[][] rows, byte[][] families, byte[][] qualifiers,
       byte[] value) throws IOException {

hbase-server/src/test/java/org/apache/hadoop/hbase/coprocessor/TestOpenTableInCoprocessor.java

@@ -94,8 +94,8 @@ public void prePut(final ObserverContext<RegionCoprocessorEnvironment> e, final
   public static class CustomThreadPoolCoprocessor implements RegionCoprocessor, RegionObserver {
 
     /**
-     * @return a pool that has only ever one thread. A second action added to the pool (running
-     * concurrently), will cause an exception.
+     * @return a pool that has one thread only at every time. A second action added to the pool (
+     *         running concurrently), will cause an exception.
      */
     private ExecutorService getPool() {
       int maxThreads = 1;

hbase-server/src/test/java/org/apache/hadoop/hbase/master/balancer/BalancerTestBase.java

@@ -328,7 +328,7 @@ protected String printMock(List<ServerAndLoad> balancedCluster) {
    *
    * @param list
    * @param plans
-   * @return the result which has all added map ServerAndLoad values
+   * @return a list of all added {@link ServerAndLoad} values.
    */
   protected List<ServerAndLoad> reconcile(List<ServerAndLoad> list,
                                           List<RegionPlan> plans,

hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/TestHStore.java

@@ -794,7 +794,7 @@ private static void flushStore(HStore store, long id) throws IOException {
    * @param numRows
    * @param qualifier
    * @param family
-   * @return KeyValues list
+   * @return row KeyValues list
    */
   List<Cell> getKeyValueSet(long[] timestamps, int numRows,
       byte[] qualifier, byte[] family) {

hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/TestHStoreFile.java

@@ -844,7 +844,7 @@ private HStoreFile mockStoreFile(boolean bulkLoad,
    * @param numRows
    * @param qualifier
    * @param family
-   * @return KeyValues list
+   * @return row KeyValues list
    */
   List<KeyValue> getKeyValueSet(long[] timestamps, int numRows,
       byte[] qualifier, byte[] family) {