Skip to content

Commit 41f166f

Browse files
authored
doc: fix io.grpc package level javadoc not showing up
- Resolves {@link ...} with full class name - Javadoc can show up in package-summary.html
1 parent 2860959 commit 41f166f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

core/src/main/java/io/grpc/package-info.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@
2929
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
3030
*/
3131

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

0 commit comments

Comments
 (0)