mirror of https://github.com/grpc/grpc-java.git
core,README: add docs about grpc-java-api-checker (#4182)
This commit is contained in:
parent
77e3b97f91
commit
5af2515f3e
13
README.md
13
README.md
|
@ -239,3 +239,16 @@ The [examples](https://github.com/grpc/grpc-java/tree/master/examples)
|
||||||
and the
|
and the
|
||||||
[Android example](https://github.com/grpc/grpc-java/tree/master/examples/android) are standalone projects that
|
[Android example](https://github.com/grpc/grpc-java/tree/master/examples/android) are standalone projects that
|
||||||
showcase the usage of gRPC.
|
showcase the usage of gRPC.
|
||||||
|
|
||||||
|
Tools
|
||||||
|
-----
|
||||||
|
|
||||||
|
APIs annotated with `@Internal` are for internal use by the gRPC library and
|
||||||
|
should not be used by gRPC users. APIs annotated with `@ExperimentalApi` are
|
||||||
|
subject to change in future releases, and library code that other projects
|
||||||
|
may depend on should not use these APIs. We recommend using the
|
||||||
|
[grpc-java-api-checker](https://github.com/grpc/grpc-java-api-checker)
|
||||||
|
(an [Error Prone](https://github.com/google/error-prone) plugin)
|
||||||
|
to check for usages of `@ExperimentalApi` and `@Internal` in any library code
|
||||||
|
that depends on gRPC. It may also be used to check for `@Internal` usage or
|
||||||
|
unintended `@ExperimentalApi` consumption in non-library code.
|
||||||
|
|
|
@ -36,6 +36,9 @@ import java.lang.annotation.Target;
|
||||||
*
|
*
|
||||||
* <p>Note: This annotation is intended only for gRPC library code. Users should not attach this
|
* <p>Note: This annotation is intended only for gRPC library code. Users should not attach this
|
||||||
* annotation to their own code.
|
* annotation to their own code.
|
||||||
|
*
|
||||||
|
* <p>See: <a href="https://github.com/grpc/grpc-java-api-checker">grpc-java-api-checker</a>, an
|
||||||
|
* Error Prone plugin to automatically check for usages of this API.
|
||||||
*/
|
*/
|
||||||
@Retention(RetentionPolicy.CLASS)
|
@Retention(RetentionPolicy.CLASS)
|
||||||
@Target({
|
@Target({
|
||||||
|
|
|
@ -32,6 +32,9 @@ import java.lang.annotation.Target;
|
||||||
*
|
*
|
||||||
* <p>Note: This annotation is intended only for gRPC library code. Users should not attach this
|
* <p>Note: This annotation is intended only for gRPC library code. Users should not attach this
|
||||||
* annotation to their own code.
|
* annotation to their own code.
|
||||||
|
*
|
||||||
|
* <p>See: <a href="https://github.com/grpc/grpc-java-api-checker">grpc-java-api-checker</a>, an
|
||||||
|
* Error Prone plugin to automatically check for usages of this API.
|
||||||
*/
|
*/
|
||||||
@Retention(RetentionPolicy.CLASS)
|
@Retention(RetentionPolicy.CLASS)
|
||||||
@Target({
|
@Target({
|
||||||
|
|
Loading…
Reference in New Issue