Fix javadoc warnings in ImmutableOffsetMap 71/99871/2
authorRobert Varga <robert.varga@pantheon.tech>
Fri, 25 Feb 2022 07:22:54 +0000 (08:22 +0100)
committerRobert Varga <nite@hq.sk>
Fri, 25 Feb 2022 14:23:18 +0000 (14:23 +0000)
We have undocumented K/V parameters, fix that.

Change-Id: I2dee30f7ed0cf0ad9d8124f6bd3029a15bc52156
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
common/util/src/main/java/org/opendaylight/yangtools/util/ImmutableOffsetMap.java

index 844086df746c1c314f3a2625dd1aa268543cc0ef..66b20fbdf1ec9be8cdb47ef557bc897be1b08d38 100644 (file)
@@ -117,6 +117,8 @@ public abstract class ImmutableOffsetMap<K, V> implements UnmodifiableMapPhase<K
      * {@link #toModifiableMap()}) and makes an efficient copy of its contents. All other maps are converted to an
      * {@link ImmutableOffsetMap} with the same iteration order as input.
      *
+     * @param <K> the type of keys maintained by the map
+     * @param <V> the type of mapped values
      * @param map Input map, may not be null.
      * @return An isolated, immutable copy of the input map
      * @throws NullPointerException if {@code map} or any of its elements is null.
@@ -152,6 +154,8 @@ public abstract class ImmutableOffsetMap<K, V> implements UnmodifiableMapPhase<K
      * {@link #toModifiableMap()}) and makes an efficient copy of its contents. All other maps are converted to an
      * {@link ImmutableOffsetMap}. Iterator order is not guaranteed to be retained.
      *
+     * @param <K> the type of keys maintained by the map
+     * @param <V> the type of mapped values
      * @param map Input map, may not be null.
      * @return An isolated, immutable copy of the input map
      * @throws NullPointerException if {@code map} or any of its elements is null.