Fix JavaDoc issues

This commit is contained in:
Per Minborg
2021-08-17 15:44:08 +02:00
parent 3f0493fa94
commit db725bba45
6 changed files with 10 additions and 11 deletions
@@ -57,7 +57,7 @@ public interface ChronicleHash<K, E extends HashEntry<K>, 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.
* <p>
@@ -812,7 +812,7 @@ public interface ChronicleHashBuilder<K, H extends ChronicleHash<K, ?, ?, ?>,
/**
* 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.
@@ -45,10 +45,9 @@ import static net.openhft.chronicle.hash.serialization.StatefulCopyable.copyIfNe
* .create();
* }</pre>
* <p>
* <p>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.
* <p>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 <T> the element type of serialized Lists
* @see SetMarshaller
@@ -37,8 +37,8 @@ import static net.openhft.chronicle.hash.serialization.StatefulCopyable.copyIfNe
* inefficient. See <a href="https://github.com/OpenHFT/Chronicle-Map#chronicle-map-is-not">the
* README section</a>.
* <p>
* <p>Look for pre-defined key and value marshallers in {@link
* net.openhft.chronicle.hash.serialization.impl} package. This package is not included into
* <p>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.
*
@@ -49,8 +49,8 @@ import static net.openhft.chronicle.hash.serialization.StatefulCopyable.copyIfNe
* .create();
* }</pre>
* <p>
* <p>Look for pre-defined element marshallers in {@link
* net.openhft.chronicle.hash.serialization.impl} package. This package is not included into
* <p>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.
*
@@ -252,7 +252,7 @@ public interface ChronicleMap<K, V> extends ConcurrentMap<K, V>,
* 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.
* <p>
* 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");