Docfix
authorkhizmax <libcds.dev@gmail.com>
Wed, 20 Apr 2016 20:11:19 +0000 (23:11 +0300)
committerkhizmax <libcds.dev@gmail.com>
Wed, 20 Apr 2016 20:11:19 +0000 (23:11 +0300)
cds/container/details/bronson_avltree_base.h
cds/container/impl/bronson_avltree_map_rcu.h
cds/sync/monitor.h

index 2f671648df1cc5aa95876d35bd96287318f3a937..bb709fc45505b6199a4b6dafc881e5e55ee26e18 100644 (file)
@@ -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<RCU, Key, T*, Traits> 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<GC, Key, T*, Traits>. 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<cds::sync::spin>
index 996db87f35467c0f4d5bf306cae18fb5c30d87c1..50139ca18a87440e477d7d08db9376c195d65e1a 100644 (file)
@@ -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<mapped_type>::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 <i>nearly</i> 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 <i>nearly</i> 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.
index 5a4b0888a3708f1772b8479a8685a761d15c0b0d..24817dd7db2364d9d9e17e8e59389f50f375d95f 100644 (file)
@@ -75,7 +75,7 @@ namespace cds { namespace sync {
             template <typename Node>
             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 <typename SyncMonitor>
         struct my_node