From 683152b4fc7d08d6e5b987e42fa2448e80bc3597 Mon Sep 17 00:00:00 2001 From: khizmax Date: Wed, 4 Feb 2015 17:36:22 +0300 Subject: [PATCH] Fix extract() member function doc --- cds/container/ellen_bintree_map_rcu.h | 6 +++--- cds/container/ellen_bintree_set_rcu.h | 7 +++---- cds/container/lazy_kvlist_rcu.h | 2 +- cds/container/lazy_list_rcu.h | 2 +- cds/container/michael_kvlist_rcu.h | 2 +- cds/container/michael_list_rcu.h | 2 +- cds/container/michael_map_rcu.h | 3 +-- cds/container/michael_set_rcu.h | 3 +-- cds/container/skip_list_map_rcu.h | 3 +-- cds/container/skip_list_set_rcu.h | 3 +-- cds/container/split_list_map_rcu.h | 3 +-- cds/container/split_list_set_rcu.h | 3 +-- cds/intrusive/ellen_bintree_rcu.h | 3 +-- cds/intrusive/lazy_list_rcu.h | 2 +- cds/intrusive/michael_list_rcu.h | 2 +- cds/intrusive/michael_set_rcu.h | 3 +-- cds/intrusive/skip_list_rcu.h | 3 +-- cds/intrusive/split_list_rcu.h | 3 +-- 18 files changed, 22 insertions(+), 33 deletions(-) diff --git a/cds/container/ellen_bintree_map_rcu.h b/cds/container/ellen_bintree_map_rcu.h index 1252a590..d9c3e918 100644 --- a/cds/container/ellen_bintree_map_rcu.h +++ b/cds/container/ellen_bintree_map_rcu.h @@ -392,17 +392,17 @@ namespace cds { namespace container { /// Extracts an item from the map using \p pred for searching /** - The function is an analog of \ref cds_nonintrusive_EllenBinTreeMap_rcu_extract "extract(exempt_ptr&, Q const&)" + The function is an analog of \p extract(Q const&) but \p pred is used for key compare. \p Less has the interface like \p std::less and should meet \ref cds_container_EllenBinTreeSet_rcu_less "predicate requirements". \p pred must imply the same element order as the comparator used for building the map. */ template - exempt_ptr extract_with( Q const& val, Less pred ) + exempt_ptr extract_with( Q const& key, Less pred ) { CDS_UNUSED( pred ); - return exempt_ptr( base_class::extract_with_( val, + return exempt_ptr( base_class::extract_with_( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::key_accessor >() )); } diff --git a/cds/container/ellen_bintree_set_rcu.h b/cds/container/ellen_bintree_set_rcu.h index 07a00751..eaa41355 100644 --- a/cds/container/ellen_bintree_set_rcu.h +++ b/cds/container/ellen_bintree_set_rcu.h @@ -406,17 +406,16 @@ namespace cds { namespace container { /// Extracts an item from the set using \p pred for searching /** - The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_rcu_extract "extract(exempt_ptr&, Q const&)" - but \p pred is used for key compare. + The function is an analog of \p extract(Q const&) but \p pred is used for key compare. \p Less has the interface like \p std::less and should meet \ref cds_container_EllenBinTreeSet_rcu_less "predicate requirements". \p pred must imply the same element order as the comparator used for building the set. */ template - exempt_ptr extract_with( Q const& val, Less pred ) + exempt_ptr extract_with( Q const& key, Less pred ) { CDS_UNUSED( pred ); - return exempt_ptr( base_class::extract_with_( val, + return exempt_ptr( base_class::extract_with_( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >() )); } diff --git a/cds/container/lazy_kvlist_rcu.h b/cds/container/lazy_kvlist_rcu.h index 8b9514ac..de24d131 100644 --- a/cds/container/lazy_kvlist_rcu.h +++ b/cds/container/lazy_kvlist_rcu.h @@ -559,7 +559,7 @@ namespace cds { namespace container { /// Extracts an item from the list using \p pred predicate for searching /** - This function is the analog for \ref cds_nonintrusive_LazyKVList_rcu_extract "extract(exempt_ptr&, K const&)". + This function is the analog for \p extract(K const&). The \p pred is a predicate used for key comparing. \p Less has the interface like \p std::less. \p pred must imply the same element order as \ref key_comparator. diff --git a/cds/container/lazy_list_rcu.h b/cds/container/lazy_list_rcu.h index 218a6d9e..8aec5b12 100644 --- a/cds/container/lazy_list_rcu.h +++ b/cds/container/lazy_list_rcu.h @@ -536,7 +536,7 @@ namespace cds { namespace container { /// Extracts an item from the list using \p pred predicate for searching /** - This function is the analog for \ref cds_nonintrusive_LazyList_rcu_extract "extract(exempt_ptr&, Q const&)". + This function is the analog for \p extract(Q const&). The \p pred is a predicate used for key comparing. \p Less has the interface like \p std::less. diff --git a/cds/container/michael_kvlist_rcu.h b/cds/container/michael_kvlist_rcu.h index 04d9b237..d1134300 100644 --- a/cds/container/michael_kvlist_rcu.h +++ b/cds/container/michael_kvlist_rcu.h @@ -556,7 +556,7 @@ namespace cds { namespace container { /// Extracts an item from the list using \p pred predicate for searching /** - This function is the analog for \ref cds_nonintrusive_MichaelKVList_rcu_extract "extract(exempt_ptr&, K const&)". + This function is the analog for \p extract(K const&). The \p pred is a predicate used for key comparing. \p Less has the interface like \p std::less. \p pred must imply the same element order as \ref key_comparator. diff --git a/cds/container/michael_list_rcu.h b/cds/container/michael_list_rcu.h index 4188db12..cc53b773 100644 --- a/cds/container/michael_list_rcu.h +++ b/cds/container/michael_list_rcu.h @@ -534,7 +534,7 @@ namespace cds { namespace container { /// Extracts an item from the list using \p pred predicate for searching /** - This function is the analog for \ref cds_nonintrusive_MichaelList_rcu_extract "extract(exempt_ptr&, Q const&)". + This function is the analog for \p extract(Q const&). The \p pred is a predicate used for key comparing. \p Less has the interface like \p std::less. diff --git a/cds/container/michael_map_rcu.h b/cds/container/michael_map_rcu.h index 9f17bf33..c86aaad2 100644 --- a/cds/container/michael_map_rcu.h +++ b/cds/container/michael_map_rcu.h @@ -578,8 +578,7 @@ namespace cds { namespace container { /// Extracts an item from the map using \p pred predicate for searching /** - The function is an analog of \ref cds_nonintrusive_MichaelHashMap_rcu_extract "extract(exempt_ptr&, K const&)" - but \p pred is used for key comparing. + The function is an analog of \p extract(K const&) but \p pred is used for key comparing. \p Less functor has the interface like \p std::less. \p pred must imply the same element order as the comparator used for building the map. */ diff --git a/cds/container/michael_set_rcu.h b/cds/container/michael_set_rcu.h index 1d1ebe87..86da400d 100644 --- a/cds/container/michael_set_rcu.h +++ b/cds/container/michael_set_rcu.h @@ -500,8 +500,7 @@ namespace cds { namespace container { /// Extracts an item from the set using \p pred predicate for searching /** - The function is an analog of \ref cds_nonintrusive_MichaelHashSet_rcu_extract "extract(exempt_ptr&, Q const&)" - but \p pred is used for key comparing. + The function is an analog of \p extract(Q const&) but \p pred is used for key comparing. \p Less functor has the interface like \p std::less. \p pred must imply the same element order as the comparator used for building the set. */ diff --git a/cds/container/skip_list_map_rcu.h b/cds/container/skip_list_map_rcu.h index 64f5c187..53bcf344 100644 --- a/cds/container/skip_list_map_rcu.h +++ b/cds/container/skip_list_map_rcu.h @@ -430,8 +430,7 @@ namespace cds { namespace container { /// Extracts the item from the map with comparing functor \p pred /** - The function is an analog of \ref cds_nonintrusive_SkipListMap_rcu_extract "extract(exempt_ptr&, K const&)" - but \p pred predicate is used for key comparing. + The function is an analog of \p extract(K const&) but \p pred predicate is used for key comparing. \p Less has the semantics like \p std::less. \p pred must imply the same element order as the comparator used for building the map. */ diff --git a/cds/container/skip_list_set_rcu.h b/cds/container/skip_list_set_rcu.h index e1efa00c..fb50c9d0 100644 --- a/cds/container/skip_list_set_rcu.h +++ b/cds/container/skip_list_set_rcu.h @@ -463,8 +463,7 @@ namespace cds { namespace container { /// Extracts the item from the set with comparing functor \p pred /** - The function is an analog of \ref cds_nonintrusive_SkipListSet_rcu_extract "extract(exempt_ptr&, Q const&)" - but \p pred predicate is used for key comparing. + The function is an analog of \p extract(Q const&) but \p pred predicate is used for key comparing. \p Less has the semantics like \p std::less. \p pred must imply the same element order as the comparator used for building the set. */ diff --git a/cds/container/split_list_map_rcu.h b/cds/container/split_list_map_rcu.h index 59e8008f..bb84fb2c 100644 --- a/cds/container/split_list_map_rcu.h +++ b/cds/container/split_list_map_rcu.h @@ -498,8 +498,7 @@ namespace cds { namespace container { /// Extracts an item from the map using \p pred predicate for searching /** - The function is an analog of \ref cds_nonintrusive_SplitListMap_rcu_extract "extract(exempt_ptr&, K const&)" - but \p pred is used for key comparing. + The function is an analog of \p extract(K const&) but \p pred is used for key comparing. \p Less functor has the interface like \p std::less. \p pred must imply the same element order as the comparator used for building the map. */ diff --git a/cds/container/split_list_set_rcu.h b/cds/container/split_list_set_rcu.h index 79a7c9b5..e483babe 100644 --- a/cds/container/split_list_set_rcu.h +++ b/cds/container/split_list_set_rcu.h @@ -629,8 +629,7 @@ namespace cds { namespace container { /// Extracts an item from the set using \p pred predicate for searching /** - The function is an analog of \ref cds_nonintrusive_SplitListSet_rcu_extract "extract(exempt_ptr&, Q const&)" - but \p pred is used for key comparing. + The function is an analog of \p extract(Q const&) but \p pred is used for key comparing. \p Less functor has the interface like \p std::less. \p pred must imply the same element order as the comparator used for building the set. */ diff --git a/cds/intrusive/ellen_bintree_rcu.h b/cds/intrusive/ellen_bintree_rcu.h index a6577dcd..45dc686f 100644 --- a/cds/intrusive/ellen_bintree_rcu.h +++ b/cds/intrusive/ellen_bintree_rcu.h @@ -1026,8 +1026,7 @@ namespace cds { namespace intrusive { /// Extracts an item from the set using \p pred for searching /** - The function is an analog of \ref cds_intrusive_EllenBinTree_rcu_extract "extract(exempt_ptr&, Q const&)" - but \p pred is used for key compare. + The function is an analog of \p extract(Q const&) but \p pred is used for key compare. \p Less has the interface like \p std::less and should meet \ref cds_intrusive_EllenBinTree_rcu_less "predicate requirements". \p pred must imply the same element order as the comparator used for building the tree. diff --git a/cds/intrusive/lazy_list_rcu.h b/cds/intrusive/lazy_list_rcu.h index ce42d4d7..7d3b1f53 100644 --- a/cds/intrusive/lazy_list_rcu.h +++ b/cds/intrusive/lazy_list_rcu.h @@ -629,7 +629,7 @@ namespace cds { namespace intrusive { /// Extracts an item from the list using \p pred predicate for searching /** - This function is the analog for \ref cds_intrusive_LazyList_rcu_extract "extract(exempt_ptr&, Q const&)". + This function is the analog for \p extract(Q const&). The \p pred is a predicate used for key comparing. \p Less has the interface like \p std::less. diff --git a/cds/intrusive/michael_list_rcu.h b/cds/intrusive/michael_list_rcu.h index 250c91e3..2114e83a 100644 --- a/cds/intrusive/michael_list_rcu.h +++ b/cds/intrusive/michael_list_rcu.h @@ -530,7 +530,7 @@ namespace cds { namespace intrusive { /// Extracts an item from the list using \p pred predicate for searching /** - This function is the analog for \ref cds_intrusive_MichaelList_rcu_extract "extract(exempt_ptr&, Q const&)". + This function is the analog for \p extract(Q const&) The \p pred is a predicate used for key comparing. \p Less has the interface like \p std::less. diff --git a/cds/intrusive/michael_set_rcu.h b/cds/intrusive/michael_set_rcu.h index 3980473e..7a200fde 100644 --- a/cds/intrusive/michael_set_rcu.h +++ b/cds/intrusive/michael_set_rcu.h @@ -446,8 +446,7 @@ namespace cds { namespace intrusive { /// Extracts an item from the set using \p pred predicate for searching /** - The function is an analog of \ref cds_intrusive_MichaelHashSet_rcu_extract "extract(exempt_ptr&, Q const&)" - but \p pred is used for key comparing. + The function is an analog of \p extract(Q const&) but \p pred is used for key comparing. \p Less functor has the interface like \p std::less. \p pred must imply the same element order as the comparator used for building the set. */ diff --git a/cds/intrusive/skip_list_rcu.h b/cds/intrusive/skip_list_rcu.h index f08df912..6153b559 100644 --- a/cds/intrusive/skip_list_rcu.h +++ b/cds/intrusive/skip_list_rcu.h @@ -1648,8 +1648,7 @@ retry: /// Extracts the item from the set with comparing functor \p pred /** - The function is an analog of \ref cds_intrusive_SkipListSet_rcu_extract "extract(exempt_ptr&, Q const&)" - but \p pred predicate is used for key comparing. + The function is an analog of \p extract(Q const&) but \p pred predicate is used for key comparing. \p Less has the interface like \p std::less. \p pred must imply the same element order as the comparator used for building the set. */ diff --git a/cds/intrusive/split_list_rcu.h b/cds/intrusive/split_list_rcu.h index 384b2d6d..6ca39c32 100644 --- a/cds/intrusive/split_list_rcu.h +++ b/cds/intrusive/split_list_rcu.h @@ -740,8 +740,7 @@ namespace cds { namespace intrusive { /// Extracts an item from the set using \p pred for searching /** - The function is an analog of \ref cds_intrusive_SplitListSet_rcu_extract "extract(exempt_ptr&, Q const&)" - but \p pred is used for key compare. + The function is an analog of \p extract(Q const&) but \p pred is used for key compare. \p Less functor has the interface like \p std::less. \p pred must imply the same element order as the comparator used for building the set. */ -- 2.34.1