From: khizmax Date: Sun, 7 Feb 2016 18:06:00 +0000 (+0300) Subject: Docfix X-Git-Tag: v2.2.0~406 X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=697585c4c0fc74c87a430c5fd743411e1722bccb;p=libcds.git Docfix --- diff --git a/cds/intrusive/lazy_list_rcu.h b/cds/intrusive/lazy_list_rcu.h index cfd5b0a9..7f877046 100644 --- a/cds/intrusive/lazy_list_rcu.h +++ b/cds/intrusive/lazy_list_rcu.h @@ -538,7 +538,7 @@ namespace cds { namespace intrusive { } /// Deletes the item from the list - /** \anchor cds_intrusive_LazyList_rcu_find_erase + /** The function searches an item with key equal to \p key in the list, unlinks it from the list, and returns \p true. If the item with the key equal to \p key is not found the function return \p false. @@ -559,7 +559,7 @@ namespace cds { namespace intrusive { /// Deletes the item from the list using \p pred predicate for searching /** - The function is an analog of \ref cds_intrusive_LazyList_rcu_find_erase "erase(Q const&)" + The function is an analog of \p erase(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 list. @@ -574,7 +574,7 @@ namespace cds { namespace intrusive { } /// Deletes the item from the list - /** \anchor cds_intrusive_LazyList_rcu_find_erase_func + /** The function searches an item with key equal to \p key in the list, call \p func functor with item found, unlinks it from the list, and returns \p true. The \p Func interface is @@ -602,7 +602,7 @@ namespace cds { namespace intrusive { /// Deletes the item from the list using \p pred predicate for searching /** - The function is an analog of \ref cds_intrusive_LazyList_rcu_find_erase_func "erase(Q const&, Func)" + The function is an analog of \p erase(Q const&, Func) 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 list. @@ -618,7 +618,6 @@ namespace cds { namespace intrusive { /// Extracts an item from the list /** - \anchor cds_intrusive_LazyList_rcu_extract The function searches an item with key equal to \p key in the list, unlinks it from the list, and returns \ref cds::urcu::exempt_ptr "exempt_ptr" pointer to an item found. If the item is not found the function returns empty \p exempt_ptr. @@ -626,8 +625,8 @@ namespace cds { namespace intrusive { @note The function does NOT call RCU read-side lock or synchronization, and does NOT dispose the item found. It just unlinks the item from the list and returns a pointer to it. - You should manually lock RCU before calling this function, and you should manually synchronize RCU - outside the RCU lock region before reusing returned pointer. + You should manually lock RCU before calling this function, and you should manually release + the returned exempt pointer outside the RCU lock region before reusing returned pointer. \code #include @@ -681,7 +680,7 @@ namespace cds { namespace intrusive { } /// Finds the key \p key - /** \anchor cds_intrusive_LazyList_rcu_find_func + /** The function searches the item with key equal to \p key and calls the functor \p f for item found. The interface of \p Func functor is: @@ -712,7 +711,7 @@ namespace cds { namespace intrusive { /// Finds the key \p key using \p pred predicate for searching /** - The function is an analog of contains( key ) but \p pred is used for key comparing. + The function is an analog of \p find( Q&, Func ) 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 list. */ @@ -752,7 +751,7 @@ namespace cds { namespace intrusive { /// Checks whether the map contains \p key using \p pred predicate for searching /** - The function is an analog of contains( key ) but \p pred is used for key comparing. + The function is an analog of \p contains( Q const& ) but \p pred is used for key comparing. \p Less functor has the interface like \p std::less. \p Less must imply the same element order as the comparator used for building the list. */ diff --git a/cds/intrusive/michael_list_rcu.h b/cds/intrusive/michael_list_rcu.h index 5be6c014..db0d0712 100644 --- a/cds/intrusive/michael_list_rcu.h +++ b/cds/intrusive/michael_list_rcu.h @@ -545,7 +545,7 @@ namespace cds { namespace intrusive { } /// Deletes the item from the list - /** \anchor cds_intrusive_MichaelList_rcu_erase_val + /** The function searches an item with key equal to \p key in the list, unlinks it from the list, and returns \p true. If the item with the key equal to \p key is not found the function return \p false. @@ -566,7 +566,7 @@ namespace cds { namespace intrusive { /// Deletes the item from the list using \p pred predicate for searching /** - The function is an analog of \ref cds_intrusive_MichaelList_rcu_erase_val "erase(Q const&)" + The function is an analog of \p erase(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 list. @@ -581,7 +581,7 @@ namespace cds { namespace intrusive { } /// Deletes the item from the list - /** \anchor cds_intrusive_MichaelList_rcu_erase_func + /** The function searches an item with key equal to \p key in the list, call \p func functor with item found, unlinks it from the list, and returns \p true. The \p Func interface is @@ -609,7 +609,7 @@ namespace cds { namespace intrusive { /// Deletes the item from the list using \p pred predicate for searching /** - The function is an analog of \ref cds_intrusive_MichaelList_rcu_erase_func "erase(Q const&, Func)" + The function is an analog of \p erase(Q const&, Func) 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 list. @@ -625,7 +625,6 @@ namespace cds { namespace intrusive { /// Extracts an item from the list /** - @anchor cds_intrusive_MichaelList_rcu_extract The function searches an item with key equal to \p key in the list, unlinks it from the list, and returns \ref cds::urcu::exempt_ptr "exempt_ptr" pointer to the item found. If \p key is not found the function returns an empty \p exempt_ptr. @@ -633,7 +632,7 @@ namespace cds { namespace intrusive { @note The function does NOT dispose the item found. It just unlinks the item from the list and returns a pointer to item found. You shouldn't lock RCU for current thread before calling this function, and you should manually release - \p dest exempt pointer outside the RCU lock before reusing it. + the returned exempt pointer before reusing it. \code #include @@ -685,7 +684,7 @@ namespace cds { namespace intrusive { } /// Find the key \p val - /** \anchor cds_intrusive_MichaelList_rcu_find_func + /** The function searches the item with key equal to \p key and calls the functor \p f for item found. The interface of \p Func functor is: