Mark MultiChildLoadBalancer as Internal. (grpc#10481)

larry-safran · web-flow · commit f90656293f00 · 2023-08-15T17:33:23.000-07:00
* 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.
diff --git 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
@@ -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
@@ -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
@@ -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

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ def subprojects = [`
`22`	`22`	`project(':grpc-servlet-jakarta'),`
`23`	`23`	`project(':grpc-stub'),`
`24`	`24`	`project(':grpc-testing'),`
	`25`	`+ project(':grpc-util'),`
`25`	`26`	`project(':grpc-xds'),`
`26`	`27`	`]`
`27`	`28`
Original file line number	Diff line number	Diff line change
`@@ -166,3 +166,7 @@ tasks.register("runInteropTestRemote") {`
`166`	`166`	`throw new GradleException("Interop test failed:\nthrowable:${caught}")`
`167`	`167`	`}`
`168`	`168`	`}`
	`169`	`+`
	`170`	`+tasks.named("javadoc").configure {`
	`171`	`+ enabled = false`
	`172`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -37,3 +37,7 @@ animalsniffer {`
`37`	`37`	`sourceSets.test`
`38`	`38`	`]`
`39`	`39`	`}`
	`40`	`+`
	`41`	`+tasks.named("javadoc").configure {`
	`42`	`+ exclude 'io/grpc/util/MultiChildLoadBalancer.java'`
	`43`	`+}`