From 8225d2a6a66ea86891cae1249fc7b254c9ee9c5c Mon Sep 17 00:00:00 2001 From: Kun Zhang Date: Wed, 26 Aug 2015 10:42:08 -0700 Subject: [PATCH] Add comment field to ExperimentalApi --- core/src/main/java/io/grpc/ChannelImpl.java | 2 +- core/src/main/java/io/grpc/Context.java | 2 +- core/src/main/java/io/grpc/ExperimentalApi.java | 4 ++++ 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/core/src/main/java/io/grpc/ChannelImpl.java b/core/src/main/java/io/grpc/ChannelImpl.java index ba2a6c8e0e..4df521dc54 100644 --- a/core/src/main/java/io/grpc/ChannelImpl.java +++ b/core/src/main/java/io/grpc/ChannelImpl.java @@ -255,7 +255,7 @@ public final class ChannelImpl extends Channel { * * @see ClientTransport#ping(PingCallback, Executor) */ - @ExperimentalApi + @ExperimentalApi(comment = "https://github.com/grpc/grpc-java/issues/737") public void ping(final PingCallback callback, final Executor executor) { try { obtainActiveTransport().ping(callback, executor); diff --git a/core/src/main/java/io/grpc/Context.java b/core/src/main/java/io/grpc/Context.java index e23c085522..07f01066b0 100644 --- a/core/src/main/java/io/grpc/Context.java +++ b/core/src/main/java/io/grpc/Context.java @@ -110,7 +110,7 @@ import javax.annotation.Nullable; * responsibility of the application to ensure that all contexts are properly cancelled. * */ -@ExperimentalApi +@ExperimentalApi(comment = "https://github.com/grpc/grpc-java/issues/262") public class Context { private static final Logger LOG = Logger.getLogger(Context.class.getName()); diff --git a/core/src/main/java/io/grpc/ExperimentalApi.java b/core/src/main/java/io/grpc/ExperimentalApi.java index eddd208135..6281592590 100644 --- a/core/src/main/java/io/grpc/ExperimentalApi.java +++ b/core/src/main/java/io/grpc/ExperimentalApi.java @@ -60,4 +60,8 @@ import java.lang.annotation.Target; ElementType.TYPE}) @Documented public @interface ExperimentalApi { + /** + * Context information such as links to discussion thread, tracking issue etc. + */ + String comment() default ""; }