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.
This commit is contained in:
Larry Safran 2023-08-15 17:33:23 -07:00 committed by GitHub
parent b5d7f1394d
commit f90656293f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 3 deletions

View File

@ -22,6 +22,7 @@ def subprojects = [
project(':grpc-servlet-jakarta'), project(':grpc-servlet-jakarta'),
project(':grpc-stub'), project(':grpc-stub'),
project(':grpc-testing'), project(':grpc-testing'),
project(':grpc-util'),
project(':grpc-xds'), project(':grpc-xds'),
] ]

View File

@ -166,3 +166,7 @@ tasks.register("runInteropTestRemote") {
throw new GradleException("Interop test failed:\nthrowable:${caught}") throw new GradleException("Interop test failed:\nthrowable:${caught}")
} }
} }
tasks.named("javadoc").configure {
enabled = false
}

View File

@ -37,3 +37,7 @@ animalsniffer {
sourceSets.test sourceSets.test
] ]
} }
tasks.named("javadoc").configure {
exclude 'io/grpc/util/MultiChildLoadBalancer.java'
}

View File

@ -24,6 +24,7 @@ import static io.grpc.ConnectivityState.TRANSIENT_FAILURE;
import com.google.common.annotations.VisibleForTesting; import com.google.common.annotations.VisibleForTesting;
import io.grpc.ConnectivityState; import io.grpc.ConnectivityState;
import io.grpc.Internal;
import io.grpc.LoadBalancer; import io.grpc.LoadBalancer;
import io.grpc.LoadBalancerProvider; import io.grpc.LoadBalancerProvider;
import io.grpc.Status; import io.grpc.Status;
@ -40,10 +41,9 @@ import javax.annotation.Nullable;
/** /**
* A base load balancing policy for those policies which has multiple children such as * A base load balancing policy for those policies which has multiple children such as
* ClusterManager or the petiole policies. * ClusterManager or the petiole policies. For internal use only.
*
* @since 1.58
*/ */
@Internal
public abstract class MultiChildLoadBalancer extends LoadBalancer { public abstract class MultiChildLoadBalancer extends LoadBalancer {
@VisibleForTesting @VisibleForTesting