From: khizmax Date: Fri, 5 Feb 2016 20:49:32 +0000 (+0300) Subject: Docfix X-Git-Tag: v2.2.0~413 X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=21abbeaec52f14a47679674877050ef887122c14;p=libcds.git Docfix --- diff --git a/cds/container/vyukov_mpmc_cycle_queue.h b/cds/container/vyukov_mpmc_cycle_queue.h index 41dd96ad..354af995 100644 --- a/cds/container/vyukov_mpmc_cycle_queue.h +++ b/cds/container/vyukov_mpmc_cycle_queue.h @@ -57,7 +57,7 @@ namespace cds { namespace container { /// A functor to clean item dequeued. /** - The functor calls the destructor for queue item. + The functor calls the destructor for queue item. After an item is dequeued, \p value_cleaner cleans the cell that the item has been occupied. If \p T is a complex type, \p value_cleaner may be the useful feature. @@ -153,17 +153,17 @@ namespace cds { namespace container { Template parameters - \p T - type stored in queue. - - \p Traits - queue traits, default is \p vykov_queue::traits. You can use \p vykov_queue::make_traits - metafunction to make your traits or just derive your traits from \p %vykov_queue::traits: + - \p Traits - queue traits, default is \p vyukov_queue::traits. You can use \p vyukov_queue::make_traits + metafunction to make your traits or just derive your traits from \p %vyukov_queue::traits: \code - struct myTraits: public cds::container::vykov_queue::traits { + struct myTraits: public cds::container::vyukov_queue::traits { typedef cds::atomicity::item_counter item_counter; }; typedef cds::container::VyukovMPMCCycleQueue< Foo, myTraits > myQueue; // Equivalent make_traits example: typedef cds::container::VyukovMPMCCycleQueue< cds::gc::HP, Foo, - typename cds::container::vykov_queue::make_traits< + typename cds::container::vyukov_queue::make_traits< cds::opt::item_counter< cds::atomicity::item_counter > >::type > myQueue; diff --git a/cds/intrusive/options.h b/cds/intrusive/options.h index 254b8ce2..17d73092 100644 --- a/cds/intrusive/options.h +++ b/cds/intrusive/options.h @@ -77,8 +77,8 @@ namespace cds { namespace intrusive { \endcode Predefined types for \p Type: - - opt::v::empty_disposer - the disposer that does nothing - - opt::v::delete_disposer - the disposer that calls operator \p delete + - \p opt::v::empty_disposer - the disposer that does nothing + - \p opt::v::delete_disposer - the disposer that calls operator \p delete Usually, the disposer should be stateless default-constructible functor. It is called by garbage collector in deferred mode.