SplitListMap, SplitListSet:

[libcds.git] / cds / container / michael_map_nogc.h

diff --git a/cds/container/michael_map_nogc.h b/cds/container/michael_map_nogc.h
index 737578cadaf04bcc02795da5ee4ab4cec7a0be82..aa4b2d91da8350c21935218eef6f6d95f3e40f66 100644 (file)
--- a/cds/container/michael_map_nogc.h
+++ b/cds/container/michael_map_nogc.h
@@ -397,13 +397,13 @@ namespace cds { namespace container {
 
         /// Updates the item
         /**
-            If \p key is not in the list and \p bAllowInsert is \p true, 
-            the function inserts a new item.
+            If \p key is not in the map and \p bAllowInsert is \p true, the function inserts a new item.
             Otherwise, the function returns an iterator pointing to the item found.
 
             Returns <tt> std::pair<iterator, bool> </tt> where \p first is an iterator pointing to
-            item found or inserted, \p second is true if new item has been added or \p false if the item
-            already is in the list.
+            item found or inserted (if inserting is not allowed and \p key is not found, the iterator will be \p end()), 
+            \p second is true if new item has been added or \p false if the item
+            already is in the map.
 
             @warning For \ref cds_nonintrusive_MichaelKVList_nogc "MichaelKVList" as the bucket see \ref cds_intrusive_item_creating "insert item troubleshooting".
             \ref cds_nonintrusive_LazyKVList_nogc "LazyKVList" provides exclusive access to inserted item and does not require any node-level