Skip to content

Commit 9a61846

Browse files
committed
Don't use javadoc in README
1 parent 9100b17 commit 9a61846

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Spring gRPC
2-
!["Build Status"](https://github.com/spring-projects/spring-grpc/actions/workflows/deploy.yml/badge.svg)
2+
[![Build Status](https://github.com/spring-projects/spring-grpc/actions/workflows/deploy.yml/badge.svg)](https://github.com/spring-projects/spring-grpc/actions/workflows/deploy.yml)
33

44
Welcome to the Spring gRPC project!
55

spring-grpc-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ Run it from your IDE, or on the command line with `./mvnw spring-boot:run` or `.
268268

269269
=== gRPC Client
270270

271-
To create a simple gRPC client, you can use the Spring Boot starter (see above - it's the same as for the server). Then you can inject a bean of type javadoc:org.springframework.grpc.client.GrpcChannelFactory[] and use it to create a gRPC channel. The most common usage of a channel is to create a client that binds to a service, such as the one above. The Protobuf-generated sources in your project will contain the stub classes, and they just need to be bound to a channel. For example, to bind to the `SimpleGrpc` service on a local server:
271+
To create a simple gRPC client, you can use the Spring Boot starter (see above - it's the same as for the server). Then you can inject a bean of type `GrpcChannelFactory` and use it to create a gRPC channel. The most common usage of a channel is to create a client that binds to a service, such as the one above. The Protobuf-generated sources in your project will contain the stub classes, and they just need to be bound to a channel. For example, to bind to the `SimpleGrpc` service on a local server:
272272

273273
[source,java]
274274
----
@@ -280,7 +280,7 @@ SimpleGrpc.SimpleBlockingStub stub(GrpcChannelFactory channels) {
280280

281281
Then you can inject the stub and use it in your application.
282282

283-
The default javadoc:org.springframework.grpc.client.GrpcChannelFactory[] implementation can also create a "named" channel, which you can then use to extract the configuration to connect to the server. For example:
283+
The default `GrpcChannelFactory` implementation can also create a "named" channel, which you can then use to extract the configuration to connect to the server. For example:
284284

285285
[source,java]
286286
----

0 commit comments

Comments
 (0)