From db725bba45c886b71a84db1b9c7265a4e2a1452e Mon Sep 17 00:00:00 2001 From: Per Minborg Date: Tue, 17 Aug 2021 15:44:08 +0200 Subject: [PATCH] Fix JavaDoc issues --- .../java/net/openhft/chronicle/hash/ChronicleHash.java | 2 +- .../net/openhft/chronicle/hash/ChronicleHashBuilder.java | 2 +- .../chronicle/hash/serialization/ListMarshaller.java | 7 +++---- .../chronicle/hash/serialization/MapMarshaller.java | 4 ++-- .../chronicle/hash/serialization/SetMarshaller.java | 4 ++-- src/main/java/net/openhft/chronicle/map/ChronicleMap.java | 2 +- 6 files changed, 10 insertions(+), 11 deletions(-) diff --git a/src/main/java/net/openhft/chronicle/hash/ChronicleHash.java b/src/main/java/net/openhft/chronicle/hash/ChronicleHash.java index 36a3a801d..f3d934f86 100644 --- a/src/main/java/net/openhft/chronicle/hash/ChronicleHash.java +++ b/src/main/java/net/openhft/chronicle/hash/ChronicleHash.java @@ -57,7 +57,7 @@ public interface ChronicleHash, SC extends HashSegment /** * Returns a {@code String}, useful for identifying this {@code ChronicleHash} in debugging, logging, and error reporting. {@link #toString()} of - * concrete {@code ChronicleHash} subinterfaces, {@link ChronicleMap} and {@link ChronicleSet}, has to follow {@link Map#toString()} and {@link + * concrete {@code ChronicleHash} subinterfaces, {@link ChronicleMap} and {@link ChronicleSet}, has to follow {@link Map#toString()} and {@link * Set#toString()} contracts respectively, making it not always useful (or even impossible to use, if this {@code ChronicleHash} contains a lot of * entries) for the purposes listed above. *

diff --git a/src/main/java/net/openhft/chronicle/hash/ChronicleHashBuilder.java b/src/main/java/net/openhft/chronicle/hash/ChronicleHashBuilder.java index 994112c01..87f45e076 100644 --- a/src/main/java/net/openhft/chronicle/hash/ChronicleHashBuilder.java +++ b/src/main/java/net/openhft/chronicle/hash/ChronicleHashBuilder.java @@ -812,7 +812,7 @@ public interface ChronicleHashBuilder, /** * Skips the default automatic close configuration on the {@link ChronicleHash} created by * this builder. By setting this to true, the caller agrees to closing the built {@link ChronicleHash} - * explicitly. Any pre-shutdown action configured via {@link this#setPreShutdownAction(Runnable)} + * explicitly. Any pre-shutdown action configured via {@link #setPreShutdownAction(Runnable)} * won't be executed if skipCloseOnExitHook is set to true. * * @param skipCloseOnExitHook if {@code true}, default automatic close configuration is not enabled. diff --git a/src/main/java/net/openhft/chronicle/hash/serialization/ListMarshaller.java b/src/main/java/net/openhft/chronicle/hash/serialization/ListMarshaller.java index a8f990cad..3ea130a3d 100644 --- a/src/main/java/net/openhft/chronicle/hash/serialization/ListMarshaller.java +++ b/src/main/java/net/openhft/chronicle/hash/serialization/ListMarshaller.java @@ -45,10 +45,9 @@ import static net.openhft.chronicle.hash.serialization.StatefulCopyable.copyIfNe * .create(); * } *

- *

Look for pre-defined element marshallers in {@link - * net.openhft.chronicle.hash.serialization.impl} package. This package is not included into - * Javadocs, but present in Chronicle Map distribution. If there are no existing marshallers for - * your {@code List} element type, define {@link BytesReader} and {@link BytesWriter} yourself. + *

Look for pre-defined element marshallers in the net.openhft.chronicle.hash.serialization.impl package. + * This package is not included into Javadocs, but present in Chronicle Map distribution. If there are no existing + * marshallers for your {@code List} element type, define {@link BytesReader} and {@link BytesWriter} yourself. * * @param the element type of serialized Lists * @see SetMarshaller diff --git a/src/main/java/net/openhft/chronicle/hash/serialization/MapMarshaller.java b/src/main/java/net/openhft/chronicle/hash/serialization/MapMarshaller.java index affdff306..b23198c4c 100644 --- a/src/main/java/net/openhft/chronicle/hash/serialization/MapMarshaller.java +++ b/src/main/java/net/openhft/chronicle/hash/serialization/MapMarshaller.java @@ -37,8 +37,8 @@ import static net.openhft.chronicle.hash.serialization.StatefulCopyable.copyIfNe * inefficient. See the * README section. *

- *

Look for pre-defined key and value marshallers in {@link - * net.openhft.chronicle.hash.serialization.impl} package. This package is not included into + *

Look for pre-defined key and value marshallers in the + * net.openhft.chronicle.hash.serialization.impl package. This package is not included into * Javadocs, but present in Chronicle Map distribution. If there are no existing marshallers for * your {@code Map} key or value types, define {@link BytesReader} and {@link BytesWriter} yourself. * diff --git a/src/main/java/net/openhft/chronicle/hash/serialization/SetMarshaller.java b/src/main/java/net/openhft/chronicle/hash/serialization/SetMarshaller.java index acdeb4d02..615b54f88 100644 --- a/src/main/java/net/openhft/chronicle/hash/serialization/SetMarshaller.java +++ b/src/main/java/net/openhft/chronicle/hash/serialization/SetMarshaller.java @@ -49,8 +49,8 @@ import static net.openhft.chronicle.hash.serialization.StatefulCopyable.copyIfNe * .create(); * } *

- *

Look for pre-defined element marshallers in {@link - * net.openhft.chronicle.hash.serialization.impl} package. This package is not included into + *

Look for pre-defined element marshallers in the + * net.openhft.chronicle.hash.serialization.impl package. This package is not included into * Javadocs, but present in Chronicle Map distribution. If there are no existing marshallers for * your {@code Set} element type, define {@link BytesReader} and {@link BytesWriter} yourself. * diff --git a/src/main/java/net/openhft/chronicle/map/ChronicleMap.java b/src/main/java/net/openhft/chronicle/map/ChronicleMap.java index 1b7d08d37..83386eb37 100644 --- a/src/main/java/net/openhft/chronicle/map/ChronicleMap.java +++ b/src/main/java/net/openhft/chronicle/map/ChronicleMap.java @@ -252,7 +252,7 @@ public interface ChronicleMap extends ConcurrentMap, * number of times it can automatically expand is based on the {@code net.openhft.chronicle.map.ChronicleMapBuilder#maxBloatFactor}. If the map * expands you will see an increase in the available free space. NOTE: It is not possible to expand the chronicle map manually. *

- * see also {@see net.openhft.chronicle.map.ChronicleMap#remainingAutoResizes} as these operations are related. + * @see net.openhft.chronicle.map.ChronicleMap#remainingAutoResizes as these operations are related. */ default short percentageFreeSpace() { throw new UnsupportedOperationException("todo");