From: khizmax Date: Wed, 6 Jul 2016 18:54:24 +0000 (+0300) Subject: Fixed doc typo X-Git-Tag: v2.2.0~191 X-Git-Url: http://plrg.eecs.uci.edu/git/?p=libcds.git;a=commitdiff_plain;h=e891296f3970a4d973ad69d732cb646dbbe820c5 Fixed doc typo --- diff --git a/cds/container/bronson_avltree_map_rcu.h b/cds/container/bronson_avltree_map_rcu.h index 2d24efa1..be36d86d 100644 --- a/cds/container/bronson_avltree_map_rcu.h +++ b/cds/container/bronson_avltree_map_rcu.h @@ -312,7 +312,7 @@ namespace cds { namespace container { RCU \p synchronize() method can be called. RCU should not be locked. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already exists. */ diff --git a/cds/container/cuckoo_map.h b/cds/container/cuckoo_map.h index fd7df5dc..d8dc233a 100644 --- a/cds/container/cuckoo_map.h +++ b/cds/container/cuckoo_map.h @@ -526,7 +526,7 @@ namespace cds { namespace container { - \p bNew - \p true if the item has been inserted, \p false otherwise - \p item - an item of the map for \p key - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the node has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/cuckoo_set.h b/cds/container/cuckoo_set.h index 49a131b3..96933dd4 100644 --- a/cds/container/cuckoo_set.h +++ b/cds/container/cuckoo_set.h @@ -579,7 +579,7 @@ namespace cds { namespace container { If new item has been inserted (i.e. \p bNew is \p true) then \p item and \p val arguments refer to the same thing. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the node has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/ellen_bintree_map_rcu.h b/cds/container/ellen_bintree_map_rcu.h index b38ca200..83e634eb 100644 --- a/cds/container/ellen_bintree_map_rcu.h +++ b/cds/container/ellen_bintree_map_rcu.h @@ -274,7 +274,7 @@ namespace cds { namespace container { RCU \p synchronize() method can be called. RCU should not be locked. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the node has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/ellen_bintree_set_rcu.h b/cds/container/ellen_bintree_set_rcu.h index 2acbe887..661e1124 100644 --- a/cds/container/ellen_bintree_set_rcu.h +++ b/cds/container/ellen_bintree_set_rcu.h @@ -260,7 +260,7 @@ namespace cds { namespace container { RCU \p synchronize method can be called. RCU should not be locked. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the node has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/feldman_hashmap_rcu.h b/cds/container/feldman_hashmap_rcu.h index bff5113b..fee3fcfa 100644 --- a/cds/container/feldman_hashmap_rcu.h +++ b/cds/container/feldman_hashmap_rcu.h @@ -460,7 +460,7 @@ namespace cds { namespace container { The functor may change any fields of the \p item.second. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if \p key already exists. The function locks RCU internally. diff --git a/cds/container/feldman_hashset_rcu.h b/cds/container/feldman_hashset_rcu.h index 4a707580..99dd5348 100644 --- a/cds/container/feldman_hashset_rcu.h +++ b/cds/container/feldman_hashset_rcu.h @@ -216,7 +216,7 @@ namespace cds { namespace container { The functor may change non-key fields of the \p item; however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the item has been inserted or updated, \p second is \p true if the new item has been added or \p false if the item with key equal to \p val already exists. diff --git a/cds/container/impl/bronson_avltree_map_rcu.h b/cds/container/impl/bronson_avltree_map_rcu.h index 094a69c2..55423a9d 100644 --- a/cds/container/impl/bronson_avltree_map_rcu.h +++ b/cds/container/impl/bronson_avltree_map_rcu.h @@ -306,7 +306,7 @@ namespace cds { namespace container { RCU \p synchronize() method can be called. RCU should not be locked. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new node has been added or \p false if the node with \p key already exists. */ diff --git a/cds/container/impl/ellen_bintree_map.h b/cds/container/impl/ellen_bintree_map.h index 1abde902..a5b9855b 100644 --- a/cds/container/impl/ellen_bintree_map.h +++ b/cds/container/impl/ellen_bintree_map.h @@ -265,7 +265,7 @@ namespace cds { namespace container { however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the node has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/impl/ellen_bintree_set.h b/cds/container/impl/ellen_bintree_set.h index 94a29a5d..2e00f54d 100644 --- a/cds/container/impl/ellen_bintree_set.h +++ b/cds/container/impl/ellen_bintree_set.h @@ -256,7 +256,7 @@ namespace cds { namespace container { The functor can change non-key fields of the \p item; however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the node has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/impl/feldman_hashmap.h b/cds/container/impl/feldman_hashmap.h index 2e28e3e2..60d73cf2 100644 --- a/cds/container/impl/feldman_hashmap.h +++ b/cds/container/impl/feldman_hashmap.h @@ -486,7 +486,7 @@ namespace cds { namespace container { The functor may change any fields of the \p item.second. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if \p key already exists. @warning See \ref cds_intrusive_item_creating "insert item troubleshooting" diff --git a/cds/container/impl/feldman_hashset.h b/cds/container/impl/feldman_hashset.h index da3abde9..ee48d472 100644 --- a/cds/container/impl/feldman_hashset.h +++ b/cds/container/impl/feldman_hashset.h @@ -372,7 +372,7 @@ namespace cds { namespace container { The functor may change non-key fields of the \p item; however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the item has been inserted or updated, \p second is \p true if the new item has been added or \p false if the item with key equal to \p val already exists. diff --git a/cds/container/impl/lazy_kvlist.h b/cds/container/impl/lazy_kvlist.h index 5db39fc9..5e449387 100644 --- a/cds/container/impl/lazy_kvlist.h +++ b/cds/container/impl/lazy_kvlist.h @@ -476,7 +476,7 @@ namespace cds { namespace container { during \p func call \p item is locked so it is safe to modify the item in multi-threaded environment. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. */ diff --git a/cds/container/impl/lazy_list.h b/cds/container/impl/lazy_list.h index 541f2453..f0d4bbf1 100644 --- a/cds/container/impl/lazy_list.h +++ b/cds/container/impl/lazy_list.h @@ -441,7 +441,7 @@ namespace cds { namespace container { during \p func call \p item is locked so it is safe to modify the item in multi-threaded environment. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. */ diff --git a/cds/container/impl/michael_kvlist.h b/cds/container/impl/michael_kvlist.h index 805b9c15..28f18ef6 100644 --- a/cds/container/impl/michael_kvlist.h +++ b/cds/container/impl/michael_kvlist.h @@ -459,7 +459,7 @@ namespace cds { namespace container { however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/impl/michael_list.h b/cds/container/impl/michael_list.h index 0a8818e7..514dbfd8 100644 --- a/cds/container/impl/michael_list.h +++ b/cds/container/impl/michael_list.h @@ -414,7 +414,7 @@ namespace cds { namespace container { The functor may change non-key fields of the \p item; however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/impl/skip_list_map.h b/cds/container/impl/skip_list_map.h index b0fa8577..aedf7213 100644 --- a/cds/container/impl/skip_list_map.h +++ b/cds/container/impl/skip_list_map.h @@ -348,7 +348,7 @@ namespace cds { namespace container { The functor may change any fields of the \p item.second that is \ref value_type. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if \p key already exists. @warning See \ref cds_intrusive_item_creating "insert item troubleshooting" diff --git a/cds/container/impl/skip_list_set.h b/cds/container/impl/skip_list_set.h index 5534c7c5..ae20895b 100644 --- a/cds/container/impl/skip_list_set.h +++ b/cds/container/impl/skip_list_set.h @@ -342,7 +342,7 @@ namespace cds { namespace container { The functor may change non-key fields of the \p item; however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the item has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with key equal to \p val already exists. diff --git a/cds/container/lazy_kvlist_rcu.h b/cds/container/lazy_kvlist_rcu.h index 8fd92684..1a3f60ec 100644 --- a/cds/container/lazy_kvlist_rcu.h +++ b/cds/container/lazy_kvlist_rcu.h @@ -471,7 +471,7 @@ namespace cds { namespace container { The function applies RCU lock internally. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. */ diff --git a/cds/container/lazy_list_rcu.h b/cds/container/lazy_list_rcu.h index b900a7a2..49bbaaad 100644 --- a/cds/container/lazy_list_rcu.h +++ b/cds/container/lazy_list_rcu.h @@ -443,7 +443,7 @@ namespace cds { namespace container { The function applies RCU lock internally. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. */ diff --git a/cds/container/michael_kvlist_rcu.h b/cds/container/michael_kvlist_rcu.h index f90b696d..175cc234 100644 --- a/cds/container/michael_kvlist_rcu.h +++ b/cds/container/michael_kvlist_rcu.h @@ -477,7 +477,7 @@ namespace cds { namespace container { The function applies RCU lock internally. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already is in the list. @@ -508,7 +508,7 @@ namespace cds { namespace container { The function applies RCU lock internally. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/michael_list_rcu.h b/cds/container/michael_list_rcu.h index 3a9ba738..61d16235 100644 --- a/cds/container/michael_list_rcu.h +++ b/cds/container/michael_list_rcu.h @@ -445,7 +445,7 @@ namespace cds { namespace container { The function applies RCU lock internally. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/michael_map.h b/cds/container/michael_map.h index 1adc0be8..3bd11d39 100644 --- a/cds/container/michael_map.h +++ b/cds/container/michael_map.h @@ -521,7 +521,7 @@ namespace cds { namespace container { The functor may change any fields of the \p item.second that is \p mapped_type. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/michael_map_rcu.h b/cds/container/michael_map_rcu.h index 3dd45ad3..9bce287d 100644 --- a/cds/container/michael_map_rcu.h +++ b/cds/container/michael_map_rcu.h @@ -470,7 +470,7 @@ namespace cds { namespace container { The function applies RCU lock internally. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/michael_set.h b/cds/container/michael_set.h index 9493f4bc..b3819f69 100644 --- a/cds/container/michael_set.h +++ b/cds/container/michael_set.h @@ -432,7 +432,7 @@ namespace cds { namespace container { The functor may change non-key fields of the \p item. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the set. diff --git a/cds/container/michael_set_rcu.h b/cds/container/michael_set_rcu.h index 53e43fd8..45fac82a 100644 --- a/cds/container/michael_set_rcu.h +++ b/cds/container/michael_set_rcu.h @@ -406,7 +406,7 @@ namespace cds { namespace container { The function applies RCU lock internally. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the set. diff --git a/cds/container/skip_list_map_rcu.h b/cds/container/skip_list_map_rcu.h index 64217a90..d13bb4b0 100644 --- a/cds/container/skip_list_map_rcu.h +++ b/cds/container/skip_list_map_rcu.h @@ -382,7 +382,7 @@ namespace cds { namespace container { RCU \p synchronize() method can be called. RCU should not be locked. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/skip_list_set_rcu.h b/cds/container/skip_list_set_rcu.h index 7d3f45ee..641f8487 100644 --- a/cds/container/skip_list_set_rcu.h +++ b/cds/container/skip_list_set_rcu.h @@ -388,7 +388,7 @@ namespace cds { namespace container { RCU \p synchronize method can be called. RCU should not be locked. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. */ diff --git a/cds/container/split_list_map.h b/cds/container/split_list_map.h index 56753b9a..57c460dd 100644 --- a/cds/container/split_list_map.h +++ b/cds/container/split_list_map.h @@ -393,7 +393,7 @@ namespace cds { namespace container { - \p bNew - \p true if the item has been inserted, \p false otherwise - \p item - item of the map - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already is in the map. diff --git a/cds/container/split_list_map_rcu.h b/cds/container/split_list_map_rcu.h index 2e5f9228..b9db676e 100644 --- a/cds/container/split_list_map_rcu.h +++ b/cds/container/split_list_map_rcu.h @@ -397,7 +397,7 @@ namespace cds { namespace container { The function applies RCU lock internally. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/container/split_list_set.h b/cds/container/split_list_set.h index ee62dbda..e9d44e32 100644 --- a/cds/container/split_list_set.h +++ b/cds/container/split_list_set.h @@ -509,7 +509,7 @@ namespace cds { namespace container { The functor may change non-key fields of the \p item. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already is in the map. diff --git a/cds/container/split_list_set_rcu.h b/cds/container/split_list_set_rcu.h index 819c4e5b..f0795d09 100644 --- a/cds/container/split_list_set_rcu.h +++ b/cds/container/split_list_set_rcu.h @@ -628,7 +628,7 @@ namespace cds { namespace container { The function applies RCU lock internally. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already is in the set. */ @@ -655,7 +655,7 @@ namespace cds { namespace container { The function applies RCU lock internally. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already is in the map. diff --git a/cds/container/striped_map.h b/cds/container/striped_map.h index 40b32ae3..9b155eb1 100644 --- a/cds/container/striped_map.h +++ b/cds/container/striped_map.h @@ -681,7 +681,7 @@ template - \p bNew - \p true if the item has been inserted, \p false otherwise - \p item - item of the map - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already is in the map. */ diff --git a/cds/container/striped_set.h b/cds/container/striped_set.h index e4f4ec78..2ac8f659 100644 --- a/cds/container/striped_set.h +++ b/cds/container/striped_set.h @@ -660,7 +660,7 @@ namespace cds { namespace container { The functor may change non-key fields of the \p item. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p key already is in the map. */ diff --git a/cds/container/striped_set/adapter.h b/cds/container/striped_set/adapter.h index 3f0df642..3a6bc81d 100644 --- a/cds/container/striped_set/adapter.h +++ b/cds/container/striped_set/adapter.h @@ -128,7 +128,7 @@ namespace cds { namespace container { The type \p Q can differ from \ref value_type of items storing in the container. Therefore, the \p value_type should be comparable with type \p Q and constructible from type \p Q, - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p val key already exists.
diff --git a/cds/intrusive/cuckoo_set.h b/cds/intrusive/cuckoo_set.h index 09c16590..2ebaf1ce 100644 --- a/cds/intrusive/cuckoo_set.h +++ b/cds/intrusive/cuckoo_set.h @@ -985,23 +985,23 @@ namespace cds { namespace intrusive { counter_type m_nRelocateCallCount ; ///< Count of \p relocate() function call counter_type m_nRelocateRoundCount ; ///< Count of attempts to relocate items counter_type m_nFalseRelocateCount ; ///< Count of unneeded attempts of \p relocate call - counter_type m_nSuccessRelocateCount ; ///< Count of successfull item relocating + counter_type m_nSuccessRelocateCount ; ///< Count of successful item relocating counter_type m_nRelocateAboveThresholdCount; ///< Count of item relocating above probeset threshold counter_type m_nFailedRelocateCount ; ///< Count of failed relocation attemp (when all probeset is full) counter_type m_nResizeCallCount ; ///< Count of \p resize() function call counter_type m_nFalseResizeCount ; ///< Count of false \p resize() function call (when other thread has been resized the set) - counter_type m_nResizeSuccessNodeMove; ///< Count of successfull node moving when resizing + counter_type m_nResizeSuccessNodeMove; ///< Count of successful node moving when resizing counter_type m_nResizeRelocateCall ; ///< Count of \p relocate() function call from \p resize function - counter_type m_nInsertSuccess ; ///< Count of successfull \p insert() function call + counter_type m_nInsertSuccess ; ///< Count of successful \p insert() function call counter_type m_nInsertFailed ; ///< Count of failed \p insert() function call counter_type m_nInsertResizeCount ; ///< Count of \p resize() function call from \p insert() counter_type m_nInsertRelocateCount ; ///< Count of \p relocate() function call from \p insert() counter_type m_nInsertRelocateFault ; ///< Count of failed \p relocate() function call from \p insert() counter_type m_nUpdateExistCount ; ///< Count of call \p update() function for existing node - counter_type m_nUpdateSuccessCount ; ///< Count of successfull \p insert() function call for new node + counter_type m_nUpdateSuccessCount ; ///< Count of successful \p insert() function call for new node counter_type m_nUpdateResizeCount ; ///< Count of \p resize() function call from \p update() counter_type m_nUpdateRelocateCount ; ///< Count of \p relocate() function call from \p update() counter_type m_nUpdateRelocateFault ; ///< Count of failed \p relocate() function call from \p update() @@ -2455,7 +2455,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the node has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/intrusive/ellen_bintree_rcu.h b/cds/intrusive/ellen_bintree_rcu.h index edfaf235..8957a723 100644 --- a/cds/intrusive/ellen_bintree_rcu.h +++ b/cds/intrusive/ellen_bintree_rcu.h @@ -823,7 +823,7 @@ namespace cds { namespace intrusive { RCU \p synchronize method can be called. RCU should not be locked. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the node has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/intrusive/feldman_hashset_rcu.h b/cds/intrusive/feldman_hashset_rcu.h index f9158505..8b97bfb3 100644 --- a/cds/intrusive/feldman_hashset_rcu.h +++ b/cds/intrusive/feldman_hashset_rcu.h @@ -252,7 +252,7 @@ namespace cds { namespace intrusive { - If hash value is not found and \p bInsert is \p false then the set is unchanged, the function returns std::pair - Returns std::pair where \p first is \p true if operation is successfull + Returns std::pair where \p first is \p true if operation is successful (i.e. the item has been inserted or updated), \p second is \p true if new item has been added or \p false if the set contains that hash. diff --git a/cds/intrusive/impl/ellen_bintree.h b/cds/intrusive/impl/ellen_bintree.h index 7ed69b23..f8f08633 100644 --- a/cds/intrusive/impl/ellen_bintree.h +++ b/cds/intrusive/impl/ellen_bintree.h @@ -415,7 +415,7 @@ namespace cds { namespace intrusive { The functor can change non-key fields of the \p item; however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the node has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/intrusive/impl/feldman_hashset.h b/cds/intrusive/impl/feldman_hashset.h index c21646ce..bd731d7f 100644 --- a/cds/intrusive/impl/feldman_hashset.h +++ b/cds/intrusive/impl/feldman_hashset.h @@ -672,7 +672,7 @@ namespace cds { namespace intrusive { - If hash value is not found and \p bInsert is \p false then the set is unchanged, the function returns std::pair - Returns std::pair where \p first is \p true if operation is successfull + Returns std::pair where \p first is \p true if operation is successful (i.e. the item has been inserted or updated), \p second is \p true if new item has been added or \p false if the set contains that hash. */ diff --git a/cds/intrusive/impl/lazy_list.h b/cds/intrusive/impl/lazy_list.h index 24970fc6..7033bde0 100644 --- a/cds/intrusive/impl/lazy_list.h +++ b/cds/intrusive/impl/lazy_list.h @@ -570,7 +570,7 @@ namespace cds { namespace intrusive { While the functor \p f is working the item \p item is locked, so \p func has exclusive access to the item. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the list. diff --git a/cds/intrusive/impl/michael_list.h b/cds/intrusive/impl/michael_list.h index 96b53d52..37be7ebb 100644 --- a/cds/intrusive/impl/michael_list.h +++ b/cds/intrusive/impl/michael_list.h @@ -582,7 +582,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item; however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the list. diff --git a/cds/intrusive/impl/skip_list.h b/cds/intrusive/impl/skip_list.h index 5fd0545f..57b1037a 100644 --- a/cds/intrusive/impl/skip_list.h +++ b/cds/intrusive/impl/skip_list.h @@ -1168,7 +1168,7 @@ namespace cds { namespace intrusive { If new item has been inserted (i.e. \p bNew is \p true) then \p item and \p val arguments refer to the same thing. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the node has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/intrusive/lazy_list_nogc.h b/cds/intrusive/lazy_list_nogc.h index cd31be7b..38384ee9 100644 --- a/cds/intrusive/lazy_list_nogc.h +++ b/cds/intrusive/lazy_list_nogc.h @@ -395,7 +395,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item. While the functor \p f is calling the item \p item is locked. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the list. */ diff --git a/cds/intrusive/lazy_list_rcu.h b/cds/intrusive/lazy_list_rcu.h index 244e4286..d22474a2 100644 --- a/cds/intrusive/lazy_list_rcu.h +++ b/cds/intrusive/lazy_list_rcu.h @@ -501,7 +501,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item. While the functor \p f is calling the item \p item is locked. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the list. diff --git a/cds/intrusive/michael_list_nogc.h b/cds/intrusive/michael_list_nogc.h index 5f75a6f1..3e3920ba 100644 --- a/cds/intrusive/michael_list_nogc.h +++ b/cds/intrusive/michael_list_nogc.h @@ -354,7 +354,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item; however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the list. */ diff --git a/cds/intrusive/michael_list_rcu.h b/cds/intrusive/michael_list_rcu.h index 59f8563f..2b9ae89a 100644 --- a/cds/intrusive/michael_list_rcu.h +++ b/cds/intrusive/michael_list_rcu.h @@ -510,7 +510,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item; however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the list. diff --git a/cds/intrusive/michael_set.h b/cds/intrusive/michael_set.h index 201a8275..b876b5ed 100644 --- a/cds/intrusive/michael_set.h +++ b/cds/intrusive/michael_set.h @@ -471,7 +471,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the set. diff --git a/cds/intrusive/michael_set_nogc.h b/cds/intrusive/michael_set_nogc.h index b30bff95..88998455 100644 --- a/cds/intrusive/michael_set_nogc.h +++ b/cds/intrusive/michael_set_nogc.h @@ -256,7 +256,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the set. diff --git a/cds/intrusive/michael_set_rcu.h b/cds/intrusive/michael_set_rcu.h index 4b762fea..2a5df076 100644 --- a/cds/intrusive/michael_set_rcu.h +++ b/cds/intrusive/michael_set_rcu.h @@ -344,7 +344,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the set. diff --git a/cds/intrusive/skip_list_nogc.h b/cds/intrusive/skip_list_nogc.h index 833be13e..f91fcf38 100644 --- a/cds/intrusive/skip_list_nogc.h +++ b/cds/intrusive/skip_list_nogc.h @@ -735,7 +735,7 @@ namespace cds { namespace intrusive { The functor can change non-key fields of the \p item; however, \p func must guarantee that during changing no any other modifications could be made on this item by concurrent threads. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the set. diff --git a/cds/intrusive/skip_list_rcu.h b/cds/intrusive/skip_list_rcu.h index 0fc5992a..d36df9ff 100644 --- a/cds/intrusive/skip_list_rcu.h +++ b/cds/intrusive/skip_list_rcu.h @@ -1488,7 +1488,7 @@ namespace cds { namespace intrusive { RCU \p synchronize method can be called. RCU should not be locked. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, i.e. the node has been inserted or updated, \p second is \p true if new item has been added or \p false if the item with \p key already exists. diff --git a/cds/intrusive/split_list.h b/cds/intrusive/split_list.h index 1b956049..ad45c064 100644 --- a/cds/intrusive/split_list.h +++ b/cds/intrusive/split_list.h @@ -734,7 +734,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p val already is in the list. diff --git a/cds/intrusive/split_list_nogc.h b/cds/intrusive/split_list_nogc.h index 41066182..7729950d 100644 --- a/cds/intrusive/split_list_nogc.h +++ b/cds/intrusive/split_list_nogc.h @@ -374,7 +374,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the list. diff --git a/cds/intrusive/split_list_rcu.h b/cds/intrusive/split_list_rcu.h index e27c64d8..ba461df6 100644 --- a/cds/intrusive/split_list_rcu.h +++ b/cds/intrusive/split_list_rcu.h @@ -616,7 +616,7 @@ namespace cds { namespace intrusive { The function applies RCU lock internally. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p key already is in the list. diff --git a/cds/intrusive/striped_set.h b/cds/intrusive/striped_set.h index 8aea0cb6..95779703 100644 --- a/cds/intrusive/striped_set.h +++ b/cds/intrusive/striped_set.h @@ -562,7 +562,7 @@ namespace cds { namespace intrusive { The functor may change non-key fields of the \p item. - Returns std::pair where \p first is \p true if operation is successfull, + Returns std::pair where \p first is \p true if operation is successful, \p second is \p true if new item has been added or \p false if the item with \p val already is in the set. */ diff --git a/cds/intrusive/striped_set/adapter.h b/cds/intrusive/striped_set/adapter.h index ed91ee54..aa0bab66 100644 --- a/cds/intrusive/striped_set/adapter.h +++ b/cds/intrusive/striped_set/adapter.h @@ -104,7 +104,7 @@ namespace cds { namespace intrusive { The functor can change non-key fields of the \p item. - Returns std::pair where \p first is true if operation is successfull, + Returns std::pair where \p first is true if operation is successful, \p second is true if new item has been added or \p false if the item with \p val key already exists.