From 8ebcec3c0c698a522a4e5a451188671700294a2b Mon Sep 17 00:00:00 2001
From: Rob Austin <rob.austin@boundedbuffer.co.uk>
Date: Mon, 1 Dec 2014 11:24:30 +0000
Subject: [PATCH] corrected javadoc

---
 .../openhft/chronicle/map/ChronicleMap.java   | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/src/main/java/net/openhft/chronicle/map/ChronicleMap.java b/src/main/java/net/openhft/chronicle/map/ChronicleMap.java
index fb5cd53e3..50a51e631 100755
--- a/src/main/java/net/openhft/chronicle/map/ChronicleMap.java
+++ b/src/main/java/net/openhft/chronicle/map/ChronicleMap.java
@@ -220,6 +220,7 @@ public interface ChronicleMap<K, V> extends ConcurrentMap<K, V>, ChronicleHash {
      * Calling this method may or may not block until the operating is complete depending on the
      * implementation.
      *
+     * @param key the key whose associated value is to be returned in the future
      * @return a future containing the value to which the specified key is mapped after this method
      * call, or {@code null} if no value is mapped
      * @see java.util.Map#get(java.lang.Object)
@@ -236,10 +237,12 @@ public interface ChronicleMap<K, V> extends ConcurrentMap<K, V>, ChronicleHash {
      * Calling this method may or may not block until the operating is complete depending on the
      * implementation.
      *
-     * @return a future containing the previous value associated with <tt>key</tt>, or <tt>null</tt>
-     * if there was no mapping for <tt>key</tt>. (A <tt>null</tt> return can also indicate that the
-     * map previously associated <tt>null</tt> with <tt>key</tt>, if the implementation supports
-     * <tt>null</tt> values.)
+     * @param key   key with which the specified value is to be associated
+     * @param value value to be associated with the specified key * @return a future containing the
+     *              previous value associated with <tt>key</tt>, or <tt>null</tt> if there was no
+     *              mapping for <tt>key</tt>. (A <tt>null</tt> return can also indicate that the map
+     *              previously associated <tt>null</tt> with <tt>key</tt>, if the implementation
+     *              supports <tt>null</tt> values.)
      * @see java.util.Map#put(java.lang.Object, java.lang.Object)
      * @see java.util.concurrent.Future
      */
@@ -279,8 +282,8 @@ public interface ChronicleMap<K, V> extends ConcurrentMap<K, V>, ChronicleHash {
      * differ. This method is not performant and as such we recommend it is not used in performance
      * sensitive code.
      *
-     * MAPS CONTAINING KEYS/VALUES GENERATED WITH OFF-HEAP INTERFACES ARE NOT CURRENTLY
-     * SUPPORTED, CURRENTLY ONLY KEYS/VALUES THAT IMPLEMENT SERIALIZABLE ARE SUPPORTED
+     * MAPS CONTAINING KEYS/VALUES GENERATED WITH OFF-HEAP INTERFACES ARE NOT CURRENTLY SUPPORTED,
+     * CURRENTLY ONLY KEYS/VALUES THAT IMPLEMENT SERIALIZABLE ARE SUPPORTED
      *
      * @param toFile the file to store all the entries to, the entries will be stored in JSON
      *               format
@@ -296,8 +299,8 @@ public interface ChronicleMap<K, V> extends ConcurrentMap<K, V>, ChronicleHash {
      * entries are overwritten. A write lock is only held while each individual entry is inserted
      * into the map, not over all the entries in the {@link java.io.File}
      *
-     * MAPS CONTAINING KEYS/VALUES GENERATED WITH OFF-HEAP INTERFACES ARE NOT CURRENTLY
-     * SUPPORTED, CURRENTLY ONLY KEYS/VALUES THAT IMPLEMENT SERIALIZABLE ARE SUPPORTED
+     * MAPS CONTAINING KEYS/VALUES GENERATED WITH OFF-HEAP INTERFACES ARE NOT CURRENTLY SUPPORTED,
+     * CURRENTLY ONLY KEYS/VALUES THAT IMPLEMENT SERIALIZABLE ARE SUPPORTED
      *
      * @param fromFile the file containing entries ( in JSON format ) which will be deserialized and
      *                 {@link java.util.Map#put(java.lang.Object, java.lang.Object)} into the map