From 3c5b014df777e8c46ee4571b00b2e45cfaef34a7 Mon Sep 17 00:00:00 2001
From: John Dimeo <dimeo@elderresearch.com>
Date: Sun, 17 May 2020 15:33:00 -0400
Subject: [PATCH] Javadocs for immutableObjectPrimitiveMaps.

Signed-off-by: John Dimeo <dimeo@elderresearch.com>
---
 .../api/map/immutableObjectPrimitiveMap.stg   | 20 +++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/eclipse-collections-code-generator/src/main/resources/api/map/immutableObjectPrimitiveMap.stg b/eclipse-collections-code-generator/src/main/resources/api/map/immutableObjectPrimitiveMap.stg
index 574ef5d03c..a18fa2a122 100644
--- a/eclipse-collections-code-generator/src/main/resources/api/map/immutableObjectPrimitiveMap.stg
+++ b/eclipse-collections-code-generator/src/main/resources/api/map/immutableObjectPrimitiveMap.stg
@@ -51,10 +51,30 @@ public interface ImmutableObject<name>Map\<K> extends Object<name>Map\<K>
     @Override
     \<V> ImmutableCollection\<V> collect(<name>ToObjectFunction\<? extends V> function);
 
+    /**
+     * Copy this map, associate the value with the key (replacing the value if one
+     * already exists for {@code key}), and return the copy as new immutable map.
+     * A copy is always made even if {@code key} is already associated with {@code value}.
+     * @param key the key to add
+     * @param value the value to associate with the key in the copy
+     * @return an immutable copy of this map with {@code value} associated with {@code key}
+     */
     ImmutableObject<name>Map\<K> newWithKeyValue(K key, <type> value);
 
+    /**
+     * Copy this map, remove any associated value with the key (if one exists), and
+     * return the copy as a new immutable map.
+     * @param key the key to remove
+     * @return an immutable copy of this map with {@code key} removed
+     */
     ImmutableObject<name>Map\<K> newWithoutKey(K key);
 
+    /**
+     * Copy this map, remove any associated values with the specified keys (if any exist),
+     * and return the copy as a new immutable map.
+     * @param keys the keys to remove
+     * @return an immutable copy of this map with all keys in {@code keys} removed
+     */
     ImmutableObject<name>Map\<K> newWithoutAllKeys(Iterable\<? extends K> keys);
     <if(!primitive.booleanPrimitive)><(flipUniqueValues.(name))(name)><endif>
 }