Improved HP/DHP doc
[libcds.git] / cds / gc / hp.h
index e42fedb65e58b81a8f77633a4c919ec6386a44d9..b1b3cb11a11f56c4d513dd2ce7a32b091e1c936a 100644 (file)
 #include <cds/details/lib.h>
 #include <cds/threading/model.h>
 
-/**
-    @page cds_garbage_collectors_comparison SMR (Safe Memory Reclamation schema) comparison
-    @ingroup cds_garbage_collector
-
-    <table>
-        <tr>
-            <th>Feature</th>
-            <th>%cds::gc::HP</th>
-            <th>%cds::gc::DHP</th>
-        </tr>
-        <tr>
-            <td>Max number of guarded (hazard) pointers per thread</td>
-            <td>limited (specifies in SMR object ctor)</td>
-            <td>unlimited (dynamically allocated when needed)</td>
-        </tr>
-        <tr>
-            <td>Max number of retired pointers<sup>1</sup></td>
-            <td>bounded</td>
-            <td>bounded</td>
-        </tr>
-        <tr>
-            <td>Array of retired pointers</td>
-            <td>preallocated for each thread, size is limited</td>
-            <td>global for the entire process, unlimited (dynamically allocated when needed)</td>
-        </tr>
-    </table>
-
-    <sup>1</sup>Unbounded count of retired pointer means a possibility of memory exhaustion.
-*/
-
-namespace cds {
-
-    /// Different safe memory reclamation schemas (garbage collectors)
-    /** @ingroup cds_garbage_collector
-
-        This namespace specifies different safe memory reclamation (SMR) algorithms.
-        See \ref cds_garbage_collector "Garbage collectors"
-    */
-    namespace gc {
-    } // namespace gc
-
-} // namespace cds
-
 
 #endif  // #ifndef CDSLIB_GC_HP_H