Skip to content

Commit

Permalink
Fix javadoc in example (#1714)
Browse files Browse the repository at this point in the history
Motivation:

`./gradlew javadoc` command fails due to some javadoc rules violations
in examples.

Modifications:

- Don't use self-closing tags;
- Fix a link attribute for `a` tag;
- Use `<pre>` + `{@code ...}` to not worry about manual chars escape;

Result:

`./gradlew javadoc` command is happy.
  • Loading branch information
idelpivnitskiy authored Aug 3, 2021
1 parent cb454d1 commit 8ee20bb
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
/**
* Extends the async "Hello World!" example to demonstrate use of
* <a href="https://grpc.io/docs/what-is-grpc/core-concepts/#deadlines">gRPC deadlines</a> aka timeout feature.
* <p/>
* <p>
* Start the {@link DeadlineServer} first.
*
* @see <a href="https://grpc.io/blog/deadlines/">gRPC and Deadlines</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
/**
* Extends the async "Hello World!" example to demonstrate use of
* <a href="https://grpc.io/docs/what-is-grpc/core-concepts/#deadlines">gRPC deadlines</a> aka timeout feature.
* <p/>
* <p>
* Start this server first and then run the {@link DeadlineClient}.
*
* @see <a href="https://grpc.io/blog/deadlines/">gRPC and Deadlines</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@

/**
* Implementation of the
* <a herf="https://github.com/grpc/grpc/blob/master/examples/protos/helloworld.proto">gRPC hello world example</a>
* <a href="https://github.com/grpc/grpc/blob/master/examples/protos/helloworld.proto">gRPC hello world example</a>
* using async ServiceTalk APIS.
* <p/>
* <p>
* Start the {@link HelloWorldServer} first.
*/
public final class HelloWorldClient {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@

/**
* Implementation of the
* <a herf="https://github.com/grpc/grpc/blob/master/examples/protos/helloworld.proto">gRPC hello world example</a>
* <a href="https://github.com/grpc/grpc/blob/master/examples/protos/helloworld.proto">gRPC hello world example</a>
* using async ServiceTalk APIS.
* <p/>
* <p>
* Start this server first and then run the {@link HelloWorldClient}.
*/
public class HelloWorldServer {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,10 +156,10 @@ public Single<Buffer> hello(final Single<Buffer> who,
* operators for processing it on the produce side.
* <p>
* Test with:
* <pre>
* <pre>{@code
* echo "An empty file" > sample.txt && curl -vF "[email protected]" \
* http://localhost:8080/greetings/multipart-hello
* </pre>
* }</pre>
*
* @param ctx the {@link ConnectionContext}.
* @param file the multi-part file contents.
Expand Down

0 comments on commit 8ee20bb

Please sign in to comment.