Skip to content

Commit

Permalink
Mark MultiChildLoadBalancer as Internal. (grpc#10481)
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
larry-safran authored Aug 16, 2023
1 parent b5d7f13 commit f906562
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 3 deletions.
1 change: 1 addition & 0 deletions all/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ def subprojects = [
project(':grpc-servlet-jakarta'),
project(':grpc-stub'),
project(':grpc-testing'),
project(':grpc-util'),
project(':grpc-xds'),
]

Expand Down
4 changes: 4 additions & 0 deletions gae-interop-testing/gae-jdk8/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -166,3 +166,7 @@ tasks.register("runInteropTestRemote") {
throw new GradleException("Interop test failed:\nthrowable:${caught}")
}
}

tasks.named("javadoc").configure {
enabled = false
}
4 changes: 4 additions & 0 deletions util/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,7 @@ animalsniffer {
sourceSets.test
]
}

tasks.named("javadoc").configure {
exclude 'io/grpc/util/MultiChildLoadBalancer.java'
}
6 changes: 3 additions & 3 deletions util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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
Expand Down

0 comments on commit f906562

Please sign in to comment.