root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 4 Packages Projects Releases Wiki Activity

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 <matthias@confluent.io>
This commit is contained in:
Josep Prat 2022-12-28 22:41:45 +01:00 committed by GitHub
parent 7471805989
commit 5f1810209f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
server-common/src/main/java/org/apache/kafka/server/common/serialization/AbstractApiMessageSerde.java
View File

@ -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.

2
streams/streams-scala/src/main/scala/org/apache/kafka/streams/scala/kstream/KStream.scala
View File

@ -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.