Make stylechecker and javadoc generator happy

Author: bryce-anderson

servicetalk-loadbalancer-experimental/gradle/checkstyle/suppressions.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright © 2024 Apple Inc. and the ServiceTalk project authors
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~   http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+<!DOCTYPE suppressions PUBLIC
+        "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+        "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+
+<suppressions>
+    <suppress checks="LineLength"
+              files="io[\\/]servicetalk[\\/]loadbalancer[\\/]OutlierDetectorConfig.java"/>
+</suppressions>

servicetalk-loadbalancer-experimental/src/main/java/io/servicetalk/loadbalancer/LoadBalancingPolicy.java

@@ -21,11 +21,12 @@
 
 /**
  * Definition of the selector mechanism used for load balancing.
+ * @param <ResolvedAddress> the type of the resolved address
+ * @param <C> the type of the load balanced connection
  */
 public interface LoadBalancingPolicy<ResolvedAddress, C extends LoadBalancedConnection> {
     /**
-     * The name of the load balancing policy
-     *
+     * The name of the load balancing policy.
      * @return the name of the load balancing policy
      */
     String name();
@@ -35,6 +36,7 @@ public interface LoadBalancingPolicy<ResolvedAddress, C extends LoadBalancedConn
      * @param hosts          the set of {@link Host}s to select from.
      * @param targetResource the name of the target resource, useful for debugging purposes.
      * @return a {@link HostSelector}
+     * @param <T> the refined type of the connections over which to load balance
      */
     <T extends C> HostSelector<ResolvedAddress, T> buildSelector(
             List<Host<ResolvedAddress, T>> hosts, String targetResource);

servicetalk-loadbalancer-experimental/src/main/java/io/servicetalk/loadbalancer/OutlierDetectorConfig.java

@@ -25,9 +25,8 @@
 /**
  * XDS outlier detector configuration.
  * <p>
- * See the <a href="https://www.envoyproxy.io/docs/envoy/v1.29.0/api-v3/config/cluster/v3/
-outlier_detection.proto#envoy-v3-api-msg-config-cluster-v3-outlierdetection"> Envoy docs</a> for the official
- * OutlierDetector configuration definition.
+ * See the <a href="https://www.envoyproxy.io/docs/envoy/v1.29.0/api-v3/config/cluster/v3/outlier_detection.proto#envoy-v3-api-msg-config-cluster-v3-outlierdetection">Envoy docs</a>
+ * for the official OutlierDetector configuration definition.
  */
 public final class OutlierDetectorConfig {
 

servicetalk-loadbalancer-experimental/src/main/java/io/servicetalk/loadbalancer/P2CLoadBalancingPolicy.java

@@ -29,13 +29,15 @@
  * <p>
  * This {@link LoadBalancer} selection algorithm is based on work by Michael David Mitzenmacher in The Power of Two
  * Choices in Randomized Load Balancing.
- *  @see <a href="https://www.eecs.harvard.edu/~michaelm/postscripts/tpds2001.pdf">Mitzenmacher (2001) The Power of Two
- *  Choices in Randomized Load Balancing</a>
  * <p>
  * This load balancing policy is characterized by the algorithm:
  * - select two hosts randomly: hosta, and hostb.
  * - if neither host is healthy, repeat selection process until max-effort.
  * - pick the 'best' host of the two options.
+ * @param <ResolvedAddress> the type of the resolved address.
+ * @param <C> the type of the load balanced connection.
+ * @see <a href="https://www.eecs.harvard.edu/~michaelm/postscripts/tpds2001.pdf">Mitzenmacher (2001) The Power of Two
+ *  *  Choices in Randomized Load Balancing</a>
  */
 public final class P2CLoadBalancingPolicy<ResolvedAddress, C extends LoadBalancedConnection>
         implements LoadBalancingPolicy<ResolvedAddress, C> {

servicetalk-loadbalancer-experimental/src/main/java/io/servicetalk/loadbalancer/RoundRobinLoadBalancingPolicy.java

@@ -21,10 +21,11 @@
 
 /**
  * A round-robin load balancing policy.
- *
  * This load balancing algorithm is the well known policy of selecting hosts sequentially
  * from an ordered set. If a host is considered unhealthy it is skipped the next host
  * is selected until a healthy host is found or the entire host set has been exhausted.
+ * @param <ResolvedAddress> the type of the resolved address
+ * @param <C> the type of the load balanced connection
  */
 public final class RoundRobinLoadBalancingPolicy<ResolvedAddress, C extends LoadBalancedConnection>
         implements LoadBalancingPolicy<ResolvedAddress, C> {