grpc
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: fix io.grpc package level javadoc not showing up 

- Resolves {@link ...} with full class name
- Javadoc can show up in package-summary.html
This commit is contained in:
ZHANG Dapeng 2016-07-28 12:39:48 -07:00 committed by GitHub
parent 2860959d5f
commit 41f166fd1e
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
core/src/main/java/io/grpc/package-info.java
View File

@ -29,7 +29,6 @@
* 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;
/** /**
* The gRPC core public API. * The gRPC core public API.
* *
@ -39,16 +38,17 @@ package io.grpc;
* messages, they half close their respective connections. The RPC is complete as soon as the * messages, they half close their respective connections. The RPC is complete as soon as the
* server closes. * server closes.
* *
* <p>To send an RPC, first create a {@link Channel} using {@link ManagedChannelBuilder#forTarget}. * <p>To send an RPC, first create a {@link io.grpc.Channel} using
* When using auto generate Protobuf stubs, the stub class will have constructors for wrapping the * {@link io.grpc.ManagedChannelBuilder#forTarget}. When using auto generate Protobuf stubs, the
* channel. These include {@code newBlockingStub}, {@code newStub}, and {@code newFutureStub} * stub class will have constructors for wrapping the channel. These include
* which you can use based on your design. The stub is the primary way a client interacts with a * {@code newBlockingStub}, {@code newStub}, and {@code newFutureStub} which you can use based on
* server. * your design. The stub is the primary way a client interacts with a server.
* *
* <p>To receive RPCs, create a {@link Server} using {@link ServerBuilder#forPort}. The Protobuf * <p>To receive RPCs, create a {@link io.grpc.Server} using {@link io.grpc.ServerBuilder#forPort}.
* stub will contain an abstract class called AbstractFoo, where Foo is the name of your service. * The Protobuf stub will contain an abstract class called AbstractFoo, where Foo is the name of
* Extend this class, and pass an instance of it to {@link ServerBuilder#addService}. Once your * your service. Extend this class, and pass an instance of it to
* server is built, call {@link Server#start} to begin accepting RPCs. * {@link io.grpc.ServerBuilder#addService}. Once your server is built, call
* {@link io.grpc.Server#start} to begin accepting RPCs.
* *
* <p>Both Clients and Servers should use a custom {@link java.util.concurrent.Executor}. The gRPC * <p>Both Clients and Servers should use a custom {@link java.util.concurrent.Executor}. The gRPC
* runtime includes a default executor that eases testing and examples, but is not ideal for use in * runtime includes a default executor that eases testing and examples, but is not ideal for use in
@ -68,4 +68,4 @@ package io.grpc;
* <a href="https://groups.google.com/forum/#!forum/grpc-io">grpc-io</a> if you have questions * <a href="https://groups.google.com/forum/#!forum/grpc-io">grpc-io</a> if you have questions
* about gRPC. * about gRPC.
*/ */
package io.grpc;