Fixed doxygen 1.8.10 incompabilities

[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 a85dd62ddf65f2c364b507e23c7331fd2d590cf9..f30af09ed4e7ab4c908166a0a36e1a8a467da42f 100644 (file)
--- a/cds/container/michael_map_nogc.h
+++ b/cds/container/michael_map_nogc.h
@@ -16,7 +16,7 @@ namespace cds { namespace container {
         This specialization is so-called append-only when no item
         reclamation may be performed. The class does not support deleting of map item.
 
-        See \ref cds_nonintrusive_MichaelHashMap_hp "MichaelHashMap" for description of template parameters.
+        See @ref cds_nonintrusive_MichaelHashMap_hp "MichaelHashMap" for description of template parameters.
     */
     template <
         class OrderedList,
@@ -250,7 +250,14 @@ namespace cds { namespace container {
 
     public:
         /// Initialize the map
-        /** @copydetails cds_nonintrusive_MichaelHashMap_hp_ctor
+        /**
+            The Michael's hash map is non-expandable container. You should point the average count of items \p nMaxItemCount
+            when you create an object.
+            \p nLoadFactor parameter defines average count of items per bucket and it should be small number between 1 and 10.
+            Remember, since the bucket implementation is an ordered list, searching in the bucket is linear [<tt>O(nLoadFactor)</tt>].
+            Note, that many popular STL hash map implementation uses load factor 1.
+
+            The ctor defines hash table size as rounding <tt>nMacItemCount / nLoadFactor</tt> up to nearest power of two.
         */
         MichaelHashMap(
             size_t nMaxItemCount,   ///< estimation of max item count in the hash set