Fixing javadoc

Change-Id: I1d325ae71b9f1df7a2387a134269d3e5cad12e41

@@ -36,6 +36,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
 
 
     /**
     /**
      * Returns if this multimap contains no key-value pairs.
      * Returns if this multimap contains no key-value pairs.
+     *
      * @return true if no key-value pairs exist, false otherwise
      * @return true if no key-value pairs exist, false otherwise
      */
      */
     boolean isEmpty();
     boolean isEmpty();
@@ -43,6 +44,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
     /**
     /**
      * Returns true if there is at lease one key-value pair with a key equal to
      * Returns true if there is at lease one key-value pair with a key equal to
      * key.
      * key.
+     *
      * @param key the key to query
      * @param key the key to query
      * @return true if the map contains a
      * @return true if the map contains a
      * key-value pair with key false otherwise
      * key-value pair with key false otherwise
@@ -52,6 +54,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
     /**
     /**
      * Returns true if this map contains at lease one key-value pair with a
      * Returns true if this map contains at lease one key-value pair with a
      * value equal to value.
      * value equal to value.
+     *
      * @param value the value to query
      * @param value the value to query
      * @return true if there is a key-value pair with the specified value,
      * @return true if there is a key-value pair with the specified value,
      * false otherwise.
      * false otherwise.
@@ -61,6 +64,9 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
     /**
     /**
      * Returns true if this map contains at least one key-value pair with key
      * Returns true if this map contains at least one key-value pair with key
      * and value specified.
      * and value specified.
+     *
+     * @param key the key to query
+     * @param value the value to query
      * @return true if there is a key-value pair with the specified key and
      * @return true if there is a key-value pair with the specified key and
      * value, false otherwise.
      * value, false otherwise.
      */
      */
@@ -72,6 +78,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
      * returns true, if the key-value pair already exists then behavior is
      * returns true, if the key-value pair already exists then behavior is
      * implementation specific with some implementations allowing duplicates
      * implementation specific with some implementations allowing duplicates
      * and others ignoring put requests for existing entries.
      * and others ignoring put requests for existing entries.
+     *
      * @param key the key to add
      * @param key the key to add
      * @param value the value to add
      * @param value the value to add
      * @return true if the map has changed because of this call,
      * @return true if the map has changed because of this call,
@@ -83,6 +90,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
      * Removes the key-value pair with the specified values if it exists. In
      * Removes the key-value pair with the specified values if it exists. In
      * implementations that allow duplicates which matching entry will be
      * implementations that allow duplicates which matching entry will be
      * removed is undefined.
      * removed is undefined.
+     *
      * @param key the key of the pair to be removed
      * @param key the key of the pair to be removed
      * @param value the value of the pair to be removed
      * @param value the value of the pair to be removed
      * @return true if the map changed because of this call, false otherwise.
      * @return true if the map changed because of this call, false otherwise.
@@ -95,6 +103,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
      * will remove one matching entry, which one is not defined. Equivalent to
      * will remove one matching entry, which one is not defined. Equivalent to
      * repeated calls to {@code remove()} for each key value pair but more
      * repeated calls to {@code remove()} for each key value pair but more
      * efficient.
      * efficient.
+     *
      * @param key the key of the pair to be removed
      * @param key the key of the pair to be removed
      * @param values the set of values to be removed
      * @param values the set of values to be removed
      * @return true if the map changes because of this call, false otherwise.
      * @return true if the map changes because of this call, false otherwise.
@@ -104,6 +113,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
     /**
     /**
      * Removes all values associated with the specified key as well as the key
      * Removes all values associated with the specified key as well as the key
      * itself.
      * itself.
+     *
      * @param key the key whose key-value pairs will be removed
      * @param key the key whose key-value pairs will be removed
      * @return the set of values that were removed, which may be empty, if the
      * @return the set of values that were removed, which may be empty, if the
      * values did not exist the version will be less than one.
      * values did not exist the version will be less than one.
@@ -115,6 +125,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
      * values in the iterable if each key-value pair does not already exist,
      * values in the iterable if each key-value pair does not already exist,
      * if the pair does exist the behavior is implementation specific.
      * if the pair does exist the behavior is implementation specific.
      * (Same as repeated puts but with efficiency gains.)
      * (Same as repeated puts but with efficiency gains.)
+     *
      * @param key the key to use for all pairs to be added
      * @param key the key to use for all pairs to be added
      * @param values the set of values to be added in pairs with the key
      * @param values the set of values to be added in pairs with the key
      * @return true if any change in the map results from this call,
      * @return true if any change in the map results from this call,
@@ -126,6 +137,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
      * Stores all the values in values associated with the key specified,
      * Stores all the values in values associated with the key specified,
      * removes all preexisting values and returns a collection of the removed
      * removes all preexisting values and returns a collection of the removed
      * values which may be empty if the entry did not exist.
      * values which may be empty if the entry did not exist.
+     *
      * @param key the key for all entries to be added
      * @param key the key for all entries to be added
      * @param values the values to be associated with the key
      * @param values the values to be associated with the key
      * @return the collection of removed values, which may be empty
      * @return the collection of removed values, which may be empty
@@ -135,13 +147,13 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
 
 
     /**
     /**
      * Removes all key-value pairs, after which it will be empty.
      * Removes all key-value pairs, after which it will be empty.
-     * @return irrelevant, simply used to determine if the call has completed
      */
      */
     void clear();
     void clear();
 
 
     /**
     /**
      * Returns a collection of values associated with the specified key, if the
      * Returns a collection of values associated with the specified key, if the
      * key is not in the map it will return an empty collection.
      * key is not in the map it will return an empty collection.
+     *
      * @param key the key whose associated values will be returned
      * @param key the key whose associated values will be returned
      * @return the collection of the values
      * @return the collection of the values
      * associated with the specified key, the collection may be empty
      * associated with the specified key, the collection may be empty
@@ -151,6 +163,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
     /**
     /**
      * Returns a set of the keys contained in this multimap with one or more
      * Returns a set of the keys contained in this multimap with one or more
      * associated values.
      * associated values.
+     *
      * @return the collection of all keys with one or more associated values,
      * @return the collection of all keys with one or more associated values,
      * this may be empty
      * this may be empty
      */
      */
@@ -160,6 +173,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
      * Returns a multiset of the keys present in this multimap with one or more
      * Returns a multiset of the keys present in this multimap with one or more
      * associated values each. Keys will appear once for each key-value pair
      * associated values each. Keys will appear once for each key-value pair
      * in which they participate.
      * in which they participate.
+     *
      * @return a multiset of the keys, this may be empty
      * @return a multiset of the keys, this may be empty
      */
      */
     Multiset<K> keys();
     Multiset<K> keys();
@@ -168,12 +182,14 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
      * Returns a collection of values in the set with duplicates permitted, the
      * Returns a collection of values in the set with duplicates permitted, the
      * size of this collection will equal the size of the map at the time of
      * size of this collection will equal the size of the map at the time of
      * creation.
      * creation.
+     *
      * @return a collection of values, this may be empty
      * @return a collection of values, this may be empty
      */
      */
     Multiset<V> values();
     Multiset<V> values();
 
 
     /**
     /**
      * Returns a collection of each key-value pair in this map.
      * Returns a collection of each key-value pair in this map.
+     *
      * @return a collection of all entries in the map, this may be empty
      * @return a collection of all entries in the map, this may be empty
      */
      */
     Collection<Map.Entry<K, V>> entries();
     Collection<Map.Entry<K, V>> entries();
@@ -182,6 +198,7 @@ public interface ConsistentMultimap<K, V> extends DistributedPrimitive {
      * Returns a map of keys to collections of values that reflect the set of
      * Returns a map of keys to collections of values that reflect the set of
      * key-value pairs contained in the multimap, where the key value pairs
      * key-value pairs contained in the multimap, where the key value pairs
      * would be the key paired with each of the values in the collection.
      * would be the key paired with each of the values in the collection.
+     *
      * @return a map of keys to collections of values, the returned map may be
      * @return a map of keys to collections of values, the returned map may be
      * empty.
      * empty.
      */
      */