From cfa655370bbcec5b3d4958cd3b25e7cad98251bd Mon Sep 17 00:00:00 2001
From: Idel Pivnitskiy <idel.pivnitskiy@apple.com>
Date: Mon, 2 Aug 2021 20:20:06 -0700
Subject: [PATCH] Fix javadoc in example

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.
---
 .../io/servicetalk/examples/grpc/deadline/DeadlineClient.java | 2 +-
 .../io/servicetalk/examples/grpc/deadline/DeadlineServer.java | 2 +-
 .../examples/grpc/helloworld/async/HelloWorldClient.java      | 4 ++--
 .../examples/grpc/helloworld/async/HelloWorldServer.java      | 4 ++--
 .../examples/http/jaxrs/HelloWorldJaxRsResource.java          | 4 ++--
 5 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/servicetalk-examples/grpc/deadline/src/main/java/io/servicetalk/examples/grpc/deadline/DeadlineClient.java b/servicetalk-examples/grpc/deadline/src/main/java/io/servicetalk/examples/grpc/deadline/DeadlineClient.java
index b52109292f..a299c85497 100644
--- a/servicetalk-examples/grpc/deadline/src/main/java/io/servicetalk/examples/grpc/deadline/DeadlineClient.java
+++ b/servicetalk-examples/grpc/deadline/src/main/java/io/servicetalk/examples/grpc/deadline/DeadlineClient.java
@@ -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>
diff --git a/servicetalk-examples/grpc/deadline/src/main/java/io/servicetalk/examples/grpc/deadline/DeadlineServer.java b/servicetalk-examples/grpc/deadline/src/main/java/io/servicetalk/examples/grpc/deadline/DeadlineServer.java
index 2e8fe0f132..39e9cf62a9 100644
--- a/servicetalk-examples/grpc/deadline/src/main/java/io/servicetalk/examples/grpc/deadline/DeadlineServer.java
+++ b/servicetalk-examples/grpc/deadline/src/main/java/io/servicetalk/examples/grpc/deadline/DeadlineServer.java
@@ -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>
diff --git a/servicetalk-examples/grpc/helloworld/src/main/java/io/servicetalk/examples/grpc/helloworld/async/HelloWorldClient.java b/servicetalk-examples/grpc/helloworld/src/main/java/io/servicetalk/examples/grpc/helloworld/async/HelloWorldClient.java
index 62307301ce..aa4ace1ff5 100644
--- a/servicetalk-examples/grpc/helloworld/src/main/java/io/servicetalk/examples/grpc/helloworld/async/HelloWorldClient.java
+++ b/servicetalk-examples/grpc/helloworld/src/main/java/io/servicetalk/examples/grpc/helloworld/async/HelloWorldClient.java
@@ -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 {
diff --git a/servicetalk-examples/grpc/helloworld/src/main/java/io/servicetalk/examples/grpc/helloworld/async/HelloWorldServer.java b/servicetalk-examples/grpc/helloworld/src/main/java/io/servicetalk/examples/grpc/helloworld/async/HelloWorldServer.java
index 955ea9de89..e743030477 100644
--- a/servicetalk-examples/grpc/helloworld/src/main/java/io/servicetalk/examples/grpc/helloworld/async/HelloWorldServer.java
+++ b/servicetalk-examples/grpc/helloworld/src/main/java/io/servicetalk/examples/grpc/helloworld/async/HelloWorldServer.java
@@ -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 {
diff --git a/servicetalk-examples/http/jaxrs/src/main/java/io/servicetalk/examples/http/jaxrs/HelloWorldJaxRsResource.java b/servicetalk-examples/http/jaxrs/src/main/java/io/servicetalk/examples/http/jaxrs/HelloWorldJaxRsResource.java
index b54decbd68..f08aed60bb 100644
--- a/servicetalk-examples/http/jaxrs/src/main/java/io/servicetalk/examples/http/jaxrs/HelloWorldJaxRsResource.java
+++ b/servicetalk-examples/http/jaxrs/src/main/java/io/servicetalk/examples/http/jaxrs/HelloWorldJaxRsResource.java
@@ -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 "file=@sample.txt" \
      * http://localhost:8080/greetings/multipart-hello
-     * </pre>
+     * }</pre>
      *
      * @param ctx the {@link ConnectionContext}.
      * @param file the multi-part file contents.