You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by ch...@apache.org on 2023/04/06 08:01:25 UTC

[kafka] branch trunk updated: MINOR: fix invalid usage in java docs (#13506)

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

chia7712 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 3bbff167fa2 MINOR: fix invalid usage in java docs (#13506)
3bbff167fa2 is described below

commit 3bbff167fa2aa0400d4e24fb7693ca60a67b4553
Author: Chia-Ping Tsai <ch...@gmail.com>
AuthorDate: Thu Apr 6 16:01:14 2023 +0800

    MINOR: fix invalid usage in java docs (#13506)
    
    Reviewers: Luke Chen <sh...@gmail.com>
---
 .../src/main/java/org/apache/kafka/server/util/Scheduler.java       | 2 +-
 streams/src/main/java/org/apache/kafka/streams/query/Position.java  | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/server-common/src/main/java/org/apache/kafka/server/util/Scheduler.java b/server-common/src/main/java/org/apache/kafka/server/util/Scheduler.java
index 3468e285424..fde3a979140 100644
--- a/server-common/src/main/java/org/apache/kafka/server/util/Scheduler.java
+++ b/server-common/src/main/java/org/apache/kafka/server/util/Scheduler.java
@@ -50,7 +50,7 @@ public interface Scheduler {
      * @param name The name of this task
      * @param task The task to run
      * @param delayMs The number of milliseconds to wait before the first execution
-     * @param periodMs The period in milliseconds with which to execute the task. If < 0 the task will execute only once.
+     * @param periodMs The period in milliseconds with which to execute the task. If &lt; 0 the task will execute only once.
      * @return A Future object to manage the task scheduled.
      */
     ScheduledFuture<?> schedule(String name, Runnable task, long delayMs, long periodMs);
diff --git a/streams/src/main/java/org/apache/kafka/streams/query/Position.java b/streams/src/main/java/org/apache/kafka/streams/query/Position.java
index c4814565110..089bca12cdc 100644
--- a/streams/src/main/java/org/apache/kafka/streams/query/Position.java
+++ b/streams/src/main/java/org/apache/kafka/streams/query/Position.java
@@ -57,7 +57,7 @@ public class Position {
     }
 
     /**
-     * Create a new Position and populate it with a mapping of topic -> partition -> offset.
+     * Create a new Position and populate it with a mapping of topic -&gt; partition -&gt; offset.
      * <p>
      * Note, the resulting Position does not share any structure with the provided map, so
      * subsequent changes to the map or Position will not affect the other.
@@ -95,7 +95,7 @@ public class Position {
     /**
      * Merges the provided Position into the current instance.
      * <p>
-     * If both Positions contain the same topic -> partition -> offset mapping, the resulting
+     * If both Positions contain the same topic -&gt; partition -&gt; offset mapping, the resulting
      * Position will contain a mapping with the larger of the two offsets.
      */
     public Position merge(final Position other) {
@@ -127,7 +127,7 @@ public class Position {
     }
 
     /**
-     * Return the partition -> offset mapping for a specific topic.
+     * Return the partition -&gt; offset mapping for a specific topic.
      */
     public Map<Integer, Long> getPartitionPositions(final String topic) {
         final ConcurrentHashMap<Integer, Long> bound = position.get(topic);