From e96a7f210e5f772749bc957d3a08a2799a9ee992 Mon Sep 17 00:00:00 2001 From: khizmax Date: Wed, 20 Apr 2016 23:11:19 +0300 Subject: [PATCH] Docfix --- cds/container/details/bronson_avltree_base.h | 4 ++-- cds/container/impl/bronson_avltree_map_rcu.h | 8 ++++---- cds/sync/monitor.h | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/cds/container/details/bronson_avltree_base.h b/cds/container/details/bronson_avltree_base.h index 2f671648..bb709fc4 100644 --- a/cds/container/details/bronson_avltree_base.h +++ b/cds/container/details/bronson_avltree_base.h @@ -480,11 +480,11 @@ namespace cds { namespace container { - \p opt::node_allocator - the allocator for internal nodes. Default is \ref CDS_DEFAULT_ALLOCATOR. - \p opt::allocator - the allocator for node's value. Default is \ref CDS_DEFAULT_ALLOCATOR. This option is not used in \p BronsonAVLTreeMap specialisation - - \ref cds::intrusive::opt::disposer "container::opt::disposer" - the functor used for dispose removed values. + - \p cds::intrusive::opt::disposer - the functor used for dispose removed values. The user-provided disposer is used only for pointer-oriented tree specialization like \p BronsonAVLTreeMap. When the node becomes the rounting node without value, the disposer will be called to signal that the memory for the value can be safely freed. - Default is \ref cds::intrusive::opt::delete_disposer "cds::container::opt::v::delete_disposer<>" which calls \p delete operator. + Default is \p cds::intrusive::opt::delete_disposer which calls \p delete operator. Due the nature of GC schema the disposer may be called asynchronously. - \p opt::sync_monitor - @ref cds_sync_monitor "synchronization monitor" type for node-level locking, default is \p cds::sync::injecting_monitor diff --git a/cds/container/impl/bronson_avltree_map_rcu.h b/cds/container/impl/bronson_avltree_map_rcu.h index 996db87f..50139ca1 100644 --- a/cds/container/impl/bronson_avltree_map_rcu.h +++ b/cds/container/impl/bronson_avltree_map_rcu.h @@ -366,7 +366,7 @@ namespace cds { namespace container { The functor \p Func interface: \code - struct extractor { + struct functor { void operator()( key_type const& key, std::remove_pointer::type& val) { ... } }; \endcode @@ -449,7 +449,7 @@ namespace cds { namespace container { }; \endcode If the tree is empty, \p f is not called. - Otherwise, is it called with minimal key, the pointer to corresponding value is returned + Otherwise, it is called with minimal key, the pointer to corresponding value is returned as \p exempt_ptr. @note Due the concurrent nature of the map, the function extracts nearly minimum key. @@ -520,7 +520,7 @@ namespace cds { namespace container { }; \endcode If the tree is empty, \p f is not called. - Otherwise, is it called with maximal key, the pointer to corresponding value is returned + Otherwise, it is called with maximal key, the pointer to corresponding value is returned as \p exempt_ptr. @note Due the concurrent nature of the map, the function extracts nearly maximal key. @@ -592,7 +592,7 @@ namespace cds { namespace container { The interface of \p Func functor is: \code struct functor { - void operator()( key_type const& key, mapped_type& item ); + void operator()( key_type const& key, std::remove_pointer< mapped_type )::type& item ); }; \endcode where \p item is the item found. diff --git a/cds/sync/monitor.h b/cds/sync/monitor.h index 5a4b0888..24817dd7 100644 --- a/cds/sync/monitor.h +++ b/cds/sync/monitor.h @@ -75,7 +75,7 @@ namespace cds { namespace sync { template struct node_injection: public Node { - // Monitor data to inject into container's node + // Monitor data injecting into container's node // ... }; // Locks the node @@ -89,7 +89,7 @@ namespace cds { namespace sync { using scoped_lock = monitor_scoped_lock< pool_monitor, Node >; }; \endcode - Monitor's data must be inject into container's node as \p m_SyncMonitorInjection data member: + Monitor's data must be injected into container's node as \p m_SyncMonitorInjection data member: \code template struct my_node -- 2.34.1