MINOR: fix javadoc warnings (#15527)

Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
This commit is contained in:
Gaurav Narula 2024-04-26 01:31:52 +01:00 committed by GitHub
parent df4ef5a621
commit 025f9816f1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 13 additions and 7 deletions

View File

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

View File

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

View File

@ -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";

View File

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

View File

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

View File

@ -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&lt;K, ValueAndTimestamp&lt;V&gt;&gt;}.
*
* @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&lt;K, ValueAndTimestamp&lt;V&gt;&gt;}.
*
* @param <K> key type of the store
* @param <V> value type of the store