Skip io.grpc.internal in javadoc.

Also move ExperimentalApi and Internal to io.grpc, so that they appear
in javadoc.
This commit is contained in:
Kun Zhang 2015-08-17 16:27:03 -07:00
parent b83742d61c
commit 687a6f4814
9 changed files with 9 additions and 7 deletions

View File

@ -55,6 +55,7 @@ javadoc {
source subproject.javadoc.source source subproject.javadoc.source
options.links subproject.javadoc.options.links.toArray(new String[0]) options.links subproject.javadoc.options.links.toArray(new String[0])
} }
exclude 'io/grpc/internal/**'
} }
task jacocoMerge(type: JacocoMerge) { task jacocoMerge(type: JacocoMerge) {

View File

@ -13,3 +13,5 @@ dependencies {
animalsniffer { animalsniffer {
signature = "org.codehaus.mojo.signature:java16:+@signature" signature = "org.codehaus.mojo.signature:java16:+@signature"
} }
javadoc.exclude 'io/grpc/internal/**'

View File

@ -35,7 +35,6 @@ import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.ThreadFactoryBuilder; import com.google.common.util.concurrent.ThreadFactoryBuilder;
import io.grpc.internal.ClientTransportFactory; import io.grpc.internal.ClientTransportFactory;
import io.grpc.internal.Internal;
import io.grpc.internal.SharedResourceHolder; import io.grpc.internal.SharedResourceHolder;
import io.grpc.internal.SharedResourceHolder.Resource; import io.grpc.internal.SharedResourceHolder.Resource;

View File

@ -42,7 +42,6 @@ import io.grpc.internal.ClientStreamListener;
import io.grpc.internal.ClientTransport; import io.grpc.internal.ClientTransport;
import io.grpc.internal.ClientTransport.PingCallback; import io.grpc.internal.ClientTransport.PingCallback;
import io.grpc.internal.ClientTransportFactory; import io.grpc.internal.ClientTransportFactory;
import io.grpc.internal.ExperimentalApi;
import io.grpc.internal.HttpUtil; import io.grpc.internal.HttpUtil;
import io.grpc.internal.SerializingExecutor; import io.grpc.internal.SerializingExecutor;
import io.grpc.internal.SharedResourceHolder; import io.grpc.internal.SharedResourceHolder;

View File

@ -35,7 +35,6 @@ import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.MoreExecutors; import com.google.common.util.concurrent.MoreExecutors;
import com.google.common.util.concurrent.ThreadFactoryBuilder; import com.google.common.util.concurrent.ThreadFactoryBuilder;
import io.grpc.internal.ExperimentalApi;
import io.grpc.internal.SharedResourceHolder; import io.grpc.internal.SharedResourceHolder;
import java.io.Closeable; import java.io.Closeable;

View File

@ -29,7 +29,7 @@
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
package io.grpc.internal; package io.grpc;
import java.lang.annotation.Documented; import java.lang.annotation.Documented;
import java.lang.annotation.ElementType; import java.lang.annotation.ElementType;
@ -49,6 +49,7 @@ import java.lang.annotation.Target;
* <li>Removing this annotation from an API gives it stable status.</li> * <li>Removing this annotation from an API gives it stable status.</li>
* </ol> * </ol>
*/ */
@Internal
@Retention(RetentionPolicy.SOURCE) @Retention(RetentionPolicy.SOURCE)
@Target({ @Target({
ElementType.ANNOTATION_TYPE, ElementType.ANNOTATION_TYPE,

View File

@ -29,7 +29,7 @@
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
package io.grpc.internal; package io.grpc;
import java.lang.annotation.Documented; import java.lang.annotation.Documented;
import java.lang.annotation.ElementType; import java.lang.annotation.ElementType;
@ -41,6 +41,7 @@ import java.lang.annotation.Target;
* Annotates a program element which is internal to gRPC, not part of the public API, and should not * Annotates a program element which is internal to gRPC, not part of the public API, and should not
* be used outside of gRPC codebase. * be used outside of gRPC codebase.
*/ */
@Internal
@Retention(RetentionPolicy.SOURCE) @Retention(RetentionPolicy.SOURCE)
@Target({ @Target({
ElementType.ANNOTATION_TYPE, ElementType.ANNOTATION_TYPE,

View File

@ -34,5 +34,5 @@
* *
* <p>All interfaces under this package are not public API, and should not be used outside of gRPC. * <p>All interfaces under this package are not public API, and should not be used outside of gRPC.
*/ */
@Internal @io.grpc.Internal
package io.grpc.internal; package io.grpc.internal;

View File

@ -31,7 +31,7 @@
package io.grpc.netty; package io.grpc.netty;
import io.grpc.internal.ExperimentalApi; import io.grpc.ExperimentalApi;
import io.netty.handler.codec.http2.Http2SecurityUtil; import io.netty.handler.codec.http2.Http2SecurityUtil;
import io.netty.handler.ssl.ApplicationProtocolConfig; import io.netty.handler.ssl.ApplicationProtocolConfig;
import io.netty.handler.ssl.ApplicationProtocolConfig.Protocol; import io.netty.handler.ssl.ApplicationProtocolConfig.Protocol;