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 96e9483..f1d6035 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
+        @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.
index 73215db..4a04199 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
+        @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.
index eef5927..07d7a1c 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.
 
-            @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>
@@ -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.
 
-            @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>
index ee395ae..a363c65 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.
 
-            @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>
index 9048611..d65dc84 100644 (file)
@@ -295,6 +295,7 @@ namespace cds { namespace intrusive {
         {
             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) );