Clean up various javadocs to reduce javadoc warnings during build

RB=1921104
R=ybi,juncwang,kbalasub
A=kbalasub

Author: evanw555

CHANGELOG

@@ -1,6 +1,7 @@
 28.1.4
 ------
-
+(RB=1921104)
+Clean up some javadocs to reduce javadoc warnings during build
 
 28.1.3
 ------

d2/src/main/java/com/linkedin/d2/balancer/config/BackupRequestsConverter.java

@@ -31,7 +31,7 @@
 
 
 /**
- * This class converts {@link BackupRequestsBackupRequestsConfigurationArray} into a List
+ * This class converts {@link BackupRequestsConfigurationArray} into a {@link List}
  * that can be stored in zookeeper and vice versa.
  *
  * @author Jaroslaw Odzga ([email protected])

d2/src/main/java/com/linkedin/d2/balancer/event/D2MonitorBuilder.java

@@ -60,8 +60,6 @@ public Map<URI, D2MonitorUriInfoBuilder> getUriInfoBuilderMap()
    * ClusterStats is not required to reset as the new snapshot can always overwrite the old one.
    * However it is necessary to clean uriInfoBuilderMap since we only want to keep track of the
    * unhealthy hosts in the past update interval.
-   *
-   * @return
    */
   public D2MonitorBuilder reset()
   {
@@ -76,7 +74,6 @@ public D2MonitorBuilder reset()
    * The interval is the duration between this build and previous build (or when D2MonitorBuilder is created).
    *
    * @param intervalMs since last emitting
-   * @return
    */
   public final D2Monitor build(long intervalMs)
   {

d2/src/main/java/com/linkedin/d2/balancer/simple/SimpleLoadBalancer.java

@@ -142,12 +142,11 @@ public void shutdown(PropertyEventShutdownCallback shutdown)
 
   /**
    * Given a Request, returns a TransportClient that can handle requests for the Request.
-   *
+   * The callback is given a client that can be called to retrieve data for the URN.
    *
    * @param request
    *          A request whose URI is a URL of the format "d2://>servicename</optional/path".
    * @param requestContext context for this request
-   * @return A client that can be called to retrieve data for the URN.
    * @throws ServiceUnavailableException
    *           If the load balancer can't figure out how to reach a service for the given
    *           URN, an ServiceUnavailableException will be thrown.

d2/src/main/java/com/linkedin/d2/balancer/strategies/degrader/DegraderLoadBalancerQuarantine.java

@@ -118,7 +118,7 @@ private enum QuarantineStates
    * healthCheckNTimes responsible for checking the health of the transportClient multiple times
    * at the given interval.
    *
-   * @param n: repeat times
+   * @param n repeat times
    */
   private void healthCheckNTimes(int n)
   {
@@ -235,7 +235,7 @@ public void shutdown()
   /**
    * When resetInterval set to true, reset the interval time to Update Interval time.
    * Otherwise reuse the existing interval time
-   * @param resetInterval:
+   * @param resetInterval
    */
   public void reset(boolean resetInterval)
   {

d2/src/main/java/com/linkedin/d2/balancer/strategies/degrader/DegraderLoadBalancerStrategyV3.java

@@ -62,7 +62,7 @@
 
 /**
  * Implementation of {@link LoadBalancerStrategy} with additional supports partitioning of services whereas
- * the the prior implmentations do not.
+ * the the prior implementations do not.
  *
  * @author David Hoa ([email protected])
  * @author Oby Sumampouw ([email protected])
@@ -1064,8 +1064,7 @@ public Ring<URI> getRing(long clusterGenerationId, int partitionId, List<Tracker
 
   /**
    * this call returns the ring. Ring can be null depending whether the state has been initialized or not
-   * @param partitionId
-   * @return
+   * @param partitionId partition id
    */
   public Ring<URI> getRing(int partitionId)
   {

d2/src/main/java/com/linkedin/d2/balancer/strategies/degrader/PointBasedConsistentHashRingFactory.java

@@ -115,7 +115,7 @@ public Map<T, List<Point<T>>> getPointsMap()
    * is configurable from cfg2. Also POINTS_CLEANUP_MIN_UNUSED_ENTRY is used to make sure we do not waste
    * time on clean up when the total host number is small.
    *
-   * @param size: the size of new URI list
+   * @param size the size of new URI list
    */
   private void clearPoints(int size)
   {

d2/src/main/java/com/linkedin/d2/balancer/util/HostSet.java

@@ -5,9 +5,9 @@
 import java.util.Map;
 
 /**
- * This is the return type of KepMapper.getAllPartitionsMultipleHosts
- * {@see com.linkedin.d2.balancer.util.HostToKeyMapper}
+ * This is the return type of {@link com.linkedin.d2.balancer.KeyMapper#getAllPartitionsMultipleHosts(URI, int)}.
  *
+ * @see com.linkedin.d2.balancer.util.HostToKeyMapper
  * @author Xialin Zhu
  */
 public interface HostSet

d2/src/main/java/com/linkedin/d2/balancer/util/hashing/ConsistentHashRing.java

@@ -56,7 +56,7 @@ public class ConsistentHashRing<T> implements Ring<T>
 
   /**
    * Create a consistent hash ring with given points
-   * @param points: Point list;
+   * @param points Point list;
    *
    * Note: ConsistentHashRing takes over the ownership for points and assume no
    *       changes to the list from outside.

d2/src/main/java/com/linkedin/d2/balancer/util/hashing/HashRingProvider.java

@@ -66,7 +66,7 @@ public interface HashRingProvider
    *
    * @param serviceName for which we want to retrieve the corresponding hashFunction
    * @return the hashFunction used to hash requests to the given service.
-   * @Throws ServiceUnavailableException - if the requested service is not available.
+   * @throws ServiceUnavailableException - if the requested service is not available.
    */
   HashFunction<Request> getRequestHashFunction(String serviceName) throws ServiceUnavailableException;