From 297d2a6697b45bdb87672552d7f12f01f462c461 Mon Sep 17 00:00:00 2001 From: khizmax Date: Tue, 4 Nov 2014 10:07:29 +0300 Subject: [PATCH] Fix docs --- cds/container/lazy_kvlist_nogc.h | 1 + cds/container/michael_kvlist_nogc.h | 1 + cds/container/split_list_map.h | 8 ++++---- cds/container/split_list_map_rcu.h | 4 ++-- cds/intrusive/lazy_list_nogc.h | 1 + 5 files changed, 9 insertions(+), 6 deletions(-) diff --git a/cds/container/lazy_kvlist_nogc.h b/cds/container/lazy_kvlist_nogc.h index 96e9483a..f1d6035b 100644 --- a/cds/container/lazy_kvlist_nogc.h +++ b/cds/container/lazy_kvlist_nogc.h @@ -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. diff --git a/cds/container/michael_kvlist_nogc.h b/cds/container/michael_kvlist_nogc.h index 73215dbe..4a041995 100644 --- a/cds/container/michael_kvlist_nogc.h +++ b/cds/container/michael_kvlist_nogc.h @@ -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. diff --git a/cds/container/split_list_map.h b/cds/container/split_list_map.h index eef5927a..07d7a1c1 100644 --- a/cds/container/split_list_map.h +++ b/cds/container/split_list_map.h @@ -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 @@ -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 diff --git a/cds/container/split_list_map_rcu.h b/cds/container/split_list_map_rcu.h index ee395aed..a363c656 100644 --- a/cds/container/split_list_map_rcu.h +++ b/cds/container/split_list_map_rcu.h @@ -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 diff --git a/cds/intrusive/lazy_list_nogc.h b/cds/intrusive/lazy_list_nogc.h index 90486114..d65dc84a 100644 --- a/cds/intrusive/lazy_list_nogc.h +++ b/cds/intrusive/lazy_list_nogc.h @@ -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(&m_Tail) ); -- 2.34.1