Fix docs
authorkhizmax <libcds.dev@gmail.com>
Tue, 4 Nov 2014 07:07:29 +0000 (10:07 +0300)
committerkhizmax <libcds.dev@gmail.com>
Tue, 4 Nov 2014 07:07:29 +0000 (10:07 +0300)
cds/container/lazy_kvlist_nogc.h
cds/container/michael_kvlist_nogc.h
cds/container/split_list_map.h
cds/container/split_list_map_rcu.h
cds/intrusive/lazy_list_nogc.h

index 96e9483addb05d945a30872cdad351d3dc0cd524..f1d6035b0e22fb6ca9a541367673ff222a70b723 100644 (file)
@@ -12,6 +12,7 @@ namespace cds { namespace container {
 
     /// Lazy ordered list (key-value pair, template specialization for gc::nogc)
     /** @ingroup cds_nonintrusive_list
 
     /// Lazy ordered list (key-value pair, template specialization for gc::nogc)
     /** @ingroup cds_nonintrusive_list
+        @anchor cds_nonintrusive_LazyKVList_nogc
 
         This specialization is append-only list when no item
         reclamation may be performed. The class does not support deleting of list item.
 
         This specialization is append-only list when no item
         reclamation may be performed. The class does not support deleting of list item.
index 73215dbeee9f546439d08ff066af26edae76620b..4a041995f5c780ebc400f00d700433a9a64522e8 100644 (file)
@@ -32,6 +32,7 @@ namespace cds { namespace container {
 
     /// Michael's ordered list (key-value pair, template specialization for gc::nogc)
     /** @ingroup cds_nonintrusive_list
 
     /// Michael's ordered list (key-value pair, template specialization for gc::nogc)
     /** @ingroup cds_nonintrusive_list
+        @anchor cds_nonintrusive_MichaelKVList_nogc
 
         This specialization is intended for so-called persistent usage when no item
         reclamation may be performed. The class does not support deleting of list item.
 
         This specialization is intended for so-called persistent usage when no item
         reclamation may be performed. The class does not support deleting of list item.
index eef5927ad0df70978d869f717f42250b81fc099c..07d7a1c11e45ff77f23b5c68f26c897d0f82418c 100644 (file)
@@ -285,8 +285,8 @@ namespace cds { namespace container {
             This can be useful if complete initialization of object of \p mapped_type is heavyweight and
             it is preferable that the initialization should be completed only if inserting is successful.
 
             This can be useful if complete initialization of object of \p mapped_type is heavyweight and
             it is preferable that the initialization should be completed only if inserting is successful.
 
-            @warning For \ref cds_intrusive_MichaelKVList_hp "MichaelKVList" as the bucket see \ref cds_intrusive_item_creating "insert item troubleshooting".
-            \ref cds_intrusive_LazyKVList_hp "LazyKVList" provides exclusive access to inserted item and does not require any node-level
+            @warning For \ref cds_nonintrusive_MichaelKVList_gc "MichaelKVList" as the bucket see \ref cds_intrusive_item_creating "insert item troubleshooting".
+            \ref cds_nonintrusive_LazyKVList_gc "LazyKVList" provides exclusive access to inserted item and does not require any node-level
             synchronization.
         */
         template <typename K, typename Func>
             synchronization.
         */
         template <typename K, typename Func>
@@ -335,8 +335,8 @@ namespace cds { namespace container {
             \p second is true if new item has been added or \p false if the item with \p key
             already is in the list.
 
             \p second is true if new item has been added or \p false if the item with \p key
             already is in the list.
 
-            @warning For \ref cds_intrusive_MichaelKVList_hp "MichaelKVList" as the ordered list see \ref cds_intrusive_item_creating "insert item troubleshooting".
-            \ref cds_intrusive_LazyKVList_hp "LazyKVList" provides exclusive access to inserted item and does not require any node-level
+            @warning For \ref cds_nonintrusive_MichaelKVList_gc "MichaelKVList" as the ordered list see \ref cds_intrusive_item_creating "insert item troubleshooting".
+            \ref cds_nonintrusive_LazyKVList_gc "LazyKVList" provides exclusive access to inserted item and does not require any node-level
             synchronization.
         */
         template <typename K, typename Func>
             synchronization.
         */
         template <typename K, typename Func>
index ee395aed00f09a92628c8c0dfd4e9ffdc32f743a..a363c656ba4150f400192c6363bd1961184e16cc 100644 (file)
@@ -374,8 +374,8 @@ namespace cds { namespace container {
             \p second is true if new item has been added or \p false if the item with \p key
             already is in the list.
 
             \p second is true if new item has been added or \p false if the item with \p key
             already is in the list.
 
-            @warning For \ref cds_intrusive_MichaelKVList_hp "MichaelKVList" as the ordered list see \ref cds_intrusive_item_creating "insert item troubleshooting".
-            \ref cds_intrusive_LazyKVList_hp "LazyKVList" provides exclusive access to inserted item and does not require any node-level
+            @warning For \ref cds_nonintrusive_MichaelKVList_gc "MichaelKVList" as the ordered list see \ref cds_intrusive_item_creating "insert item troubleshooting".
+            \ref cds_nonintrusive_LazyKVList_gc "LazyKVList" provides exclusive access to inserted item and does not require any node-level
             synchronization.
         */
         template <typename K, typename Func>
             synchronization.
         */
         template <typename K, typename Func>
index 90486114043bb1934834dc395beeeb24f577b2f1..d65dc84aafe77e8027e7d0307b83ae8ae6985c99 100644 (file)
@@ -295,6 +295,7 @@ namespace cds { namespace intrusive {
         {
             return cend();
         }
         {
             return cend();
         }
+        /// Returns an const iterator that addresses the location succeeding the last element in a list
         const_iterator cend() const
         {
             return const_iterator( const_cast<node_type *>(&m_Tail) );
         const_iterator cend() const
         {
             return const_iterator( const_cast<node_type *>(&m_Tail) );