From f90656293f00bca47193f474c2a2284cda21aab7 Mon Sep 17 00:00:00 2001 From: Larry Safran Date: Tue, 15 Aug 2023 17:33:23 -0700 Subject: [PATCH] Mark MultiChildLoadBalancer as Internal. (#10481) * Mark MultiChildLoadBalancer as Internal. Cannot move to the internal package because of its use of classes in the util package. * Exclude MultiChildLoadBalancer from javadoc generation. * Fix javadoc creation. --- all/build.gradle | 1 + gae-interop-testing/gae-jdk8/build.gradle | 4 ++++ util/build.gradle | 4 ++++ util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java | 6 +++--- 4 files changed, 12 insertions(+), 3 deletions(-) diff --git a/all/build.gradle b/all/build.gradle index fe9ba187980..dceee473316 100644 --- a/all/build.gradle +++ b/all/build.gradle @@ -22,6 +22,7 @@ def subprojects = [ project(':grpc-servlet-jakarta'), project(':grpc-stub'), project(':grpc-testing'), + project(':grpc-util'), project(':grpc-xds'), ] diff --git a/gae-interop-testing/gae-jdk8/build.gradle b/gae-interop-testing/gae-jdk8/build.gradle index f3ff765ddfb..81aeda54a49 100644 --- a/gae-interop-testing/gae-jdk8/build.gradle +++ b/gae-interop-testing/gae-jdk8/build.gradle @@ -166,3 +166,7 @@ tasks.register("runInteropTestRemote") { throw new GradleException("Interop test failed:\nthrowable:${caught}") } } + +tasks.named("javadoc").configure { + enabled = false +} diff --git a/util/build.gradle b/util/build.gradle index af4e6044ef2..6234bdc8f86 100644 --- a/util/build.gradle +++ b/util/build.gradle @@ -37,3 +37,7 @@ animalsniffer { sourceSets.test ] } + +tasks.named("javadoc").configure { + exclude 'io/grpc/util/MultiChildLoadBalancer.java' +} diff --git a/util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java b/util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java index 3671505a345..be0a23a1642 100644 --- a/util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java +++ b/util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java @@ -24,6 +24,7 @@ import com.google.common.annotations.VisibleForTesting; import io.grpc.ConnectivityState; +import io.grpc.Internal; import io.grpc.LoadBalancer; import io.grpc.LoadBalancerProvider; import io.grpc.Status; @@ -40,10 +41,9 @@ /** * A base load balancing policy for those policies which has multiple children such as - * ClusterManager or the petiole policies. - * - * @since 1.58 + * ClusterManager or the petiole policies. For internal use only. */ +@Internal public abstract class MultiChildLoadBalancer extends LoadBalancer { @VisibleForTesting