[kafka] branch trunk updated: MINOR: Fix small warning on javadoc and scaladoc (#11049)

[mj...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mjsax pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new 5f1810209f2 MINOR: Fix small warning on javadoc and scaladoc (#11049)
5f1810209f2 is described below

commit 5f1810209f2ec0f3c40a30586dfb3f6b051f1a41
Author: Josep Prat <jo...@aiven.io>
AuthorDate: Wed Dec 28 22:41:45 2022 +0100

    MINOR: Fix small warning on javadoc and scaladoc (#11049)
    
    Escape the `>` character in javadoc
    Escape the `$` character when part of `${}` in scaladoc as this is the way to reference a variable
    
    Reviewers: Matthias J. Sax <ma...@confluent.io>
---
 .../kafka/server/common/serialization/AbstractApiMessageSerde.java      | 2 +-
 .../src/main/scala/org/apache/kafka/streams/scala/kstream/KStream.scala | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/server-common/src/main/java/org/apache/kafka/server/common/serialization/AbstractApiMessageSerde.java b/server-common/src/main/java/org/apache/kafka/server/common/serialization/AbstractApiMessageSerde.java
index 753317858fc..c3914ea47b5 100644
--- a/server-common/src/main/java/org/apache/kafka/server/common/serialization/AbstractApiMessageSerde.java
+++ b/server-common/src/main/java/org/apache/kafka/server/common/serialization/AbstractApiMessageSerde.java
@@ -33,7 +33,7 @@ import org.apache.kafka.server.common.ApiMessageAndVersion;
  * <p></p>
  * <pre>
  *     [data_frame_version header message]
- *     header => [api_key version]
+ *     header =&gt; [api_key version]
  *
  *     data_frame_version   : This is the header version, current value is 0. Header includes both api_key and version.
  *     api_key              : apiKey of {@code ApiMessageAndVersion} object.
diff --git a/streams/streams-scala/src/main/scala/org/apache/kafka/streams/scala/kstream/KStream.scala b/streams/streams-scala/src/main/scala/org/apache/kafka/streams/scala/kstream/KStream.scala
index 59a3f5aeddb..e46f8f5f402 100644
--- a/streams/streams-scala/src/main/scala/org/apache/kafka/streams/scala/kstream/KStream.scala
+++ b/streams/streams-scala/src/main/scala/org/apache/kafka/streams/scala/kstream/KStream.scala
@@ -404,7 +404,7 @@ class KStream[K, V](val inner: KStreamJ[K, V]) {
    * <p>
    * The created topic is considered as an internal topic and is meant to be used only by the current Kafka Streams instance.
    * Similar to auto-repartitioning, the topic will be created with infinite retention time and data will be automatically purged by Kafka Streams.
-   * The topic will be named as "${applicationId}-&lt;name&gt;-repartition", where "applicationId" is user-specified in
+   * The topic will be named as "\${applicationId}-&lt;name&gt;-repartition", where "applicationId" is user-specified in
    * `StreamsConfig` via parameter `APPLICATION_ID_CONFIG APPLICATION_ID_CONFIG`,
    * "&lt;name&gt;" is either provided via `Repartitioned#as(String)` or an internally
    * generated name, and "-repartition" is a fixed suffix.