HDDS-11122. Fix javadoc warnings

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/SCMCommonPlacementPolicy.java

@@ -582,17 +582,17 @@ protected Node getPlacementGroup(DatanodeDetails dn) {
    * replication is computed.
    * The algorithm starts with creating a replicaIdMap which contains the
    * replicas grouped by replica Index. A placementGroup Map is created which
-   * groups replicas based on their rack & the replicas within the rack
+   * groups replicas based on their rack & the replicas within the rack
    * are further grouped based on the replica Index.
    * A placement Group Count Map is created which keeps
    * track of the count of replicas in each rack.
    * We iterate through overreplicated replica indexes sorted in descending
    * order based on their current replication factor in a descending factor.
    * For each replica Index the replica is removed from the rack which contains
    * the most replicas, in order to achieve this the racks are put
-   * into priority queue & are based on the number of replicas they have.
-   * The replica is removed from the rack with maximum replicas & the replica
-   * to be removed is also removed from the maps created above &
+   * into priority queue & are based on the number of replicas they have.
+   * The replica is removed from the rack with maximum replicas & the replica
+   * to be removed is also removed from the maps created above &
    * the count for rack is reduced.
    * The set of replicas computed are then returned by the function.
    * @param replicas: Set of existing replicas of the container

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/ContainerManager.java

@@ -164,7 +164,6 @@ void updateContainerReplica(ContainerID containerID, ContainerReplica replica)
    *
    * @param containerID Container ID
    * @param replica ContainerReplica
-   * @return True of dataNode is removed successfully else false.
    */
   void removeContainerReplica(ContainerID containerID, ContainerReplica replica)
       throws ContainerNotFoundException, ContainerReplicaNotFoundException;

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/container/placement/metrics/SCMNodeMetric.java

@@ -42,8 +42,7 @@ public SCMNodeMetric(SCMNodeStat stat) {
    * @param capacity  in bytes
    * @param used      in bytes
    * @param remaining in bytes
-   * @param committed
-   * @paaram committed in bytes
+   * @param committed in bytes
    */
   @VisibleForTesting
   public SCMNodeMetric(long capacity, long used, long remaining,

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/node/NodeStateManager.java

@@ -791,7 +791,7 @@ public void run() {
    *
    * This method is synchronized to coordinate node state updates between
    * the upgrade finalization thread which calls this method, and the
-   * node health processing thread that calls {@link this#checkNodesHealth}.
+   * node health processing thread that calls {@link #checkNodesHealth}.
    */
   public synchronized void forceNodesToHealthyReadOnly() {
     try {
@@ -817,7 +817,7 @@ public synchronized void forceNodesToHealthyReadOnly() {
   /**
    * This method is synchronized to coordinate node state updates between
    * the upgrade finalization thread which calls
-   * {@link this#forceNodesToHealthyReadOnly}, and the node health processing
+   * {@link #forceNodesToHealthyReadOnly}, and the node health processing
    * thread that calls this method.
    */
   @VisibleForTesting

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/pipeline/PipelineStateManager.java

@@ -45,8 +45,7 @@ void addPipeline(HddsProtos.Pipeline pipelineProto)
 
   /**
    * Removing pipeline would be replicated to Ratis.
-   * @param pipelineIDProto
-   * @return Pipeline removed
+   * @param pipelineIDProto Pipeline
    * @throws IOException
    */
   @Replicate

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/security/RootCARotationManager.java

@@ -121,15 +121,15 @@ public class RootCARotationManager extends StatefulService {
    *                         (1)   (3)(4)
    *                   --------------------------->
    *                         (2)                        scm2(Follower)
-   *    (1) (3)(4)     <---------------------------
+   *    (1) (3)(4)     &lt;---------------------------
    *     -------      |
    *    |        \   |
    *     ----->  scm1(Leader)
    *    \  (2)  |     \
    *     ------->      \      (1)  (3)(4)
    *                   --------------------------->
    *                          (2)                       scm3(Follower)
-   *                   <---------------------------
+   *                   &lt;---------------------------
    *
    *
    *   (1) Rotation Prepare

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/SCMDatanodeHeartbeatDispatcher.java

@@ -289,12 +289,12 @@ public interface ContainerReport {
   public enum ContainerReportType {
     /**
      * Incremental container report type
-     * {@liks IncrementalContainerReportFromDatanode}.
+     * {@link IncrementalContainerReportFromDatanode}.
      */
     ICR,
     /**
      * Full container report type
-     * {@liks ContainerReportFromDatanode}.
+     * {@link ContainerReportFromDatanode}.
      */
     FCR
   }

hadoop-hdds/server-scm/src/main/java/org/apache/hadoop/hdds/scm/server/SCMHTTPServerConfig.java

@@ -70,9 +70,10 @@ public String getKerberosKeytab() {
    * This static class is required to support other classes
    * that reference the key names and also require attributes.
    * Example: SCMSecurityProtocol where the KerberosInfo references
-   * the old configuration with the annotation shown below:-
-   * @KerberosInfo(serverPrincipal =
-   *    ScmConfigKeys.HDDS_SCM_KERBEROS_PRINCIPAL_KEY)
+   * the old configuration with the annotation shown below:
+   * <br>
+   * {@code KerberosInfo(serverPrincipal =
+   *    ScmConfigKeys.HDDS_SCM_KERBEROS_PRINCIPAL_KEY)}
    */
   public static class ConfigStrings {
     public static final String HDDS_SCM_HTTP_AUTH_CONFIG_PREFIX =

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/OFSPath.java

@@ -214,7 +214,7 @@ public String toString() {
   }
 
   /**
-   * Get the volume & bucket or mount name (non-key path).
+   * Get the volume & bucket or mount name (non-key path).
    * @return String of path excluding key in bucket.
    */
   // Prepend a delimiter at beginning. e.g. /vol1/buc1

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/exceptions/OMLeaderNotReadyException.java

@@ -24,7 +24,7 @@
  * Exception thrown by
  * {@link org.apache.hadoop.ozone.om.protocolPB.OzoneManagerProtocolPB} when
  * OM leader is not ready to serve requests. This error is thrown when Raft
- * Server returns {@link org.apache.ratis.protocol.LeaderNotReadyException}.
+ * Server returns {@link org.apache.ratis.protocol.exceptions.LeaderNotReadyException}.
  */
 public class OMLeaderNotReadyException extends IOException  {
 

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/RepeatedOmKeyInfo.java

@@ -34,7 +34,7 @@
 /**
  * Args for deleted keys. This is written to om metadata deletedTable.
  * Once a key is deleted, it is moved to om metadata deletedTable. Having a
- * {label: List<OMKeyInfo>} ensures that if users create & delete keys with
+ * label: {@code List<OMKeyInfo>} ensures that if users create &amp; delete keys with
  * exact same uri multiple times, all the delete instances are bundled under
  * the same key name. This is useful as part of GDPR compliance where an
  * admin wants to confirm if a given key is deleted from deletedTable metadata.

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/SnapshotInfo.java

@@ -52,7 +52,7 @@
  * Each snapshot created has an associated SnapshotInfo entry
  * containing the snapshotId, snapshot path,
  * snapshot checkpoint directory, previous snapshotId
- * for the snapshot path & global amongst other necessary fields.
+ * for the snapshot path & global amongst other necessary fields.
  */
 public final class SnapshotInfo implements Auditable, CopyObject<SnapshotInfo> {
   private static final Codec<SnapshotInfo> CODEC = new DelegatedCodec<>(

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/security/acl/OzoneObjInfo.java

@@ -24,7 +24,7 @@
 
 /**
  * Class representing an ozone object.
- * It can be a volume with non-null volumeName (bucketName=null & name=null)
+ * It can be a volume with non-null volumeName {@literal (bucketName=null & name=null)}
  * or a bucket with non-null volumeName and bucketName (name=null)
  * or a key with non-null volumeName, bucketName and key name
  * (via getKeyName)

hadoop-ozone/interface-storage/src/main/java/org/apache/hadoop/ozone/om/OMMetadataManager.java

@@ -647,7 +647,7 @@ String getMultipartKey(long volumeId, long bucketId,
   long getBucketId(String volume, String bucket) throws IOException;
 
   /**
-   * Returns List<{@link BlockGroup}> for a key in the deletedTable.
+   * Returns List&lt;{@link BlockGroup}&gt; for a key in the deletedTable.
    * @param deletedKey - key to be purged from the deletedTable
    * @return {@link BlockGroup}
    */

hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/ListIterator.java

@@ -43,7 +43,7 @@
 
 /**
  * Common class to do listing of resources after merging
- * rocksDB table cache & actual table.
+ * rocksDB table cache & actual table.
  */
 public class ListIterator {
 

hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMMultiTenantManager.java

@@ -129,7 +129,7 @@ boolean isTenantAdmin(UserGroupInformation callerUgi, String tenantId,
       boolean delegated);
 
   /**
-   * List all the user & accessIDs of all users that belong to this Tenant.
+   * List all the user & accessIDs of all users that belong to this Tenant.
    * Note this read is unprotected. See OzoneManager#listUserInTenant
    * @param tenantID
    * @return List of users

hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMMultiTenantManagerImpl.java

@@ -246,7 +246,6 @@ private void checkAcquiredAuthorizerWriteLock() throws OMException {
      * @param tenantId tenant name
      * @param userRoleName user role name
      * @param adminRoleName admin role name
-     * @return Tenant
      * @throws IOException
      */
     @Override

hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/multitenant/AuthorizerLock.java

@@ -43,7 +43,7 @@ public interface AuthorizerLock {
 
   /**
    * @return stamp that can be passed to
-   *    {@link this#validateOptimisticRead(long)} to check if a write lock was
+   *    {@link #validateOptimisticRead(long)} to check if a write lock was
    *    acquired since the stamp was issued.
    * @throws IOException If an ongoing write prevents the lock from moving to
    *    the read state for longer than the timeout.

hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/key/OMKeyCommitRequest.java

@@ -458,7 +458,6 @@ protected List<OmKeyLocationInfo> getOmKeyLocationInfos(
    * @param omMetrics        om metrics
    * @param exception        exception trace
    * @param omKeyInfo        omKeyInfo
-   * @param result           result
    * @param result           stores the result of the execution
    */
   @SuppressWarnings("parameternumber")

hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/key/OMKeyRequest.java

@@ -623,7 +623,7 @@ protected FileEncryptionInfo getFileEncryptionInfo(KeyArgs keyArgs) {
 
   /**
    * Check bucket quota in bytes.
-   * @paran metadataManager
+   * @param metadataManager
    * @param omBucketInfo
    * @param allocateSize
    * @throws IOException

hadoop-ozone/ozonefs-common/src/main/java/org/apache/hadoop/fs/ozone/OzoneFSInputStream.java

@@ -193,7 +193,6 @@ public int read(long position, ByteBuffer buf) throws IOException {
   /**
    * @param buf the ByteBuffer to receive the results of the read operation.
    * @param position offset
-   * @return void
    * @throws IOException if there is some error performing the read
    * @throws EOFException if end of file reached before reading fully
    */