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 025f9816f1a MINOR: fix javadoc warnings (#15527)
025f9816f1a is described below
commit 025f9816f1a15d14aab25c9e8e5b03a87f0cefe2
Author: Gaurav Narula <gaurav_naru...@apple.com>
AuthorDate: Fri Apr 26 01:31:52 2024 +0100
MINOR: fix javadoc warnings (#15527)
Reviewers: Chia-Ping Tsai <chia7...@gmail.com>
---
.../org/apache/kafka/clients/admin/FinalizedVersionRange.java | 2 +-
core/src/main/java/kafka/log/remote/RemoteLogManager.java | 8 ++++++++
.../kafka/server/log/remote/storage/RemoteStorageMetrics.java | 2 --
.../src/main/java/org/apache/kafka/streams/query/RangeQuery.java | 2 +-
.../org/apache/kafka/streams/query/TimestampedRangeQuery.java | 2 +-
.../java/org/apache/kafka/streams/state/QueryableStoreTypes.java | 4 ++--
6 files changed, 13 insertions(+), 7 deletions(-)
diff --git
a/clients/src/main/java/org/apache/kafka/clients/admin/FinalizedVersionRange.java
b/clients/src/main/java/org/apache/kafka/clients/admin/FinalizedVersionRange.java
index 22ecb8d4d22..189ffe82357 100644
---
a/clients/src/main/java/org/apache/kafka/clients/admin/FinalizedVersionRange.java
+++
b/clients/src/main/java/org/apache/kafka/clients/admin/FinalizedVersionRange.java
@@ -28,7 +28,7 @@ public class FinalizedVersionRange {
/**
* Raises an exception unless the following condition is met:
- * minVersionLevel >= 1 and maxVersionLevel >= 1 and maxVersionLevel >=
minVersionLevel.
+ * {@code minVersionLevel >= 1} and {@code maxVersionLevel >= 1} and
{@code maxVersionLevel >= minVersionLevel}.
*
* @param minVersionLevel The minimum version level value.
* @param maxVersionLevel The maximum version level value.
diff --git a/core/src/main/java/kafka/log/remote/RemoteLogManager.java
b/core/src/main/java/kafka/log/remote/RemoteLogManager.java
index c2c7d84d95c..262702a75b6 100644
--- a/core/src/main/java/kafka/log/remote/RemoteLogManager.java
+++ b/core/src/main/java/kafka/log/remote/RemoteLogManager.java
@@ -1285,6 +1285,8 @@ public class RemoteLogManager implements Closeable {
* does not contain any messages/records associated with them.
*
* For ex:
+ * <pre>
+ * {@code
* <epoch - start offset>
* 0 - 0
* 1 - 10
@@ -1294,8 +1296,12 @@ public class RemoteLogManager implements Closeable {
* 5 - 60 // epoch 5 does not have records or messages associated with it
* 6 - 60
* 7 - 70
+ * }
+ * </pre>
*
* When the above leaderEpochMap is passed to this method, it returns the
following map:
+ * <pre>
+ * {@code
* <epoch - start offset>
* 0 - 0
* 1 - 10
@@ -1304,6 +1310,8 @@ public class RemoteLogManager implements Closeable {
* 4 - 40
* 6 - 60
* 7 - 70
+ * }
+ * </pre>
*
* @param leaderEpochs The leader epoch map to be refined.
*/
diff --git
a/storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteStorageMetrics.java
b/storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteStorageMetrics.java
index 2ce004c249a..feba86a1ad0 100644
---
a/storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteStorageMetrics.java
+++
b/storage/api/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteStorageMetrics.java
@@ -27,8 +27,6 @@ import java.util.Set;
/**
* This class contains the metrics related to tiered storage feature, which is
to have a centralized
* place to store them, so that we can verify all of them easily.
- *
- * @see kafka.api.MetricsTest
*/
public class RemoteStorageMetrics {
private static final String REMOTE_LOG_READER_METRICS_NAME_PREFIX =
"RemoteLogReader";
diff --git
a/streams/src/main/java/org/apache/kafka/streams/query/RangeQuery.java
b/streams/src/main/java/org/apache/kafka/streams/query/RangeQuery.java
index b336546398f..b665a393b81 100644
--- a/streams/src/main/java/org/apache/kafka/streams/query/RangeQuery.java
+++ b/streams/src/main/java/org/apache/kafka/streams/query/RangeQuery.java
@@ -90,7 +90,7 @@ public final class RangeQuery<K, V> implements
Query<KeyValueIterator<K, V>> {
/**
* Interactive range query using an upper bound to filter the keys
returned.
- * If both <K,V> are null, RangQuery returns a full range scan.
+ * If both {@code <K,V>} are null, RangQuery returns a full range scan.
* @param upper The key that specifies the upper bound of the range
* @param <K> The key type
* @param <V> The value type
diff --git
a/streams/src/main/java/org/apache/kafka/streams/query/TimestampedRangeQuery.java
b/streams/src/main/java/org/apache/kafka/streams/query/TimestampedRangeQuery.java
index cd291638bcb..6b962c89eac 100644
---
a/streams/src/main/java/org/apache/kafka/streams/query/TimestampedRangeQuery.java
+++
b/streams/src/main/java/org/apache/kafka/streams/query/TimestampedRangeQuery.java
@@ -65,7 +65,7 @@ public final class TimestampedRangeQuery<K, V> implements
Query<KeyValueIterator
/**
* Interactive range query using an upper bound to filter the keys
returned.
- * If both <K,V> are null, RangQuery returns a full range scan.
+ * If both {@code <K,V>} are null, RangQuery returns a full range scan.
* @param upper The key that specifies the upper bound of the range
* @param <K> The key type
* @param <V> The value type
diff --git
a/streams/src/main/java/org/apache/kafka/streams/state/QueryableStoreTypes.java
b/streams/src/main/java/org/apache/kafka/streams/state/QueryableStoreTypes.java
index 343d27473d7..c818d08e53d 100644
---
a/streams/src/main/java/org/apache/kafka/streams/state/QueryableStoreTypes.java
+++
b/streams/src/main/java/org/apache/kafka/streams/state/QueryableStoreTypes.java
@@ -49,7 +49,7 @@ public final class QueryableStoreTypes {
}
/**
- * A {@link QueryableStoreType} that accepts {@link ReadOnlyKeyValueStore
ReadOnlyKeyValueStore<K, ValueAndTimestamp<V>>}.
+ * A {@link QueryableStoreType} that accepts {@link ReadOnlyKeyValueStore
ReadOnlyKeyValueStore<K, ValueAndTimestamp<V>>}.
*
* @param <K> key type of the store
* @param <V> value type of the store
@@ -71,7 +71,7 @@ public final class QueryableStoreTypes {
}
/**
- * A {@link QueryableStoreType} that accepts {@link ReadOnlyWindowStore
ReadOnlyWindowStore<K, ValueAndTimestamp<V>>}.
+ * A {@link QueryableStoreType} that accepts {@link ReadOnlyWindowStore
ReadOnlyWindowStore<K, ValueAndTimestamp<V>>}.
*
* @param <K> key type of the store
* @param <V> value type of the store
