From 258032093b65ad34cc4b901b6ddbd6f1401d36a8 Mon Sep 17 00:00:00 2001 From: khizmax Date: Tue, 5 Jul 2016 23:32:46 +0300 Subject: [PATCH] Docfix --- cds/intrusive/details/michael_list_base.h | 4 ++-- cds/intrusive/details/split_list_base.h | 18 +++++++----------- cds/intrusive/impl/michael_list.h | 2 +- cds/intrusive/split_list.h | 2 +- cds/opt/options.h | 2 +- 5 files changed, 12 insertions(+), 16 deletions(-) diff --git a/cds/intrusive/details/michael_list_base.h b/cds/intrusive/details/michael_list_base.h index 5be0a267..2b72b262 100644 --- a/cds/intrusive/details/michael_list_base.h +++ b/cds/intrusive/details/michael_list_base.h @@ -25,7 +25,7 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef CDSLIB_INTRUSIVE_DETAILS_MICHAEL_LIST_BASE_H @@ -261,7 +261,7 @@ namespace cds { namespace intrusive { - \p opt::item_counter - the type of item counting feature. Default is disabled (\p atomicity::empty_item_counter). To enable item counting use \p atomicity::item_counter. - \p opt::memory_model - C++ memory ordering model. Can be \p opt::v::relaxed_ordering (relaxed memory model, the default) - or \p opt::v::sequential_consistent (sequentially consisnent memory model). + or \p opt::v::sequential_consistent (sequentially consistent memory model). - \p opt::rcu_check_deadlock - a deadlock checking policy for \ref cds_intrusive_MichaelList_rcu "RCU-based MichaelList" Default is \p opt::v::rcu_throw_deadlock */ diff --git a/cds/intrusive/details/split_list_base.h b/cds/intrusive/details/split_list_base.h index 8f90aa25..b7b846ad 100644 --- a/cds/intrusive/details/split_list_base.h +++ b/cds/intrusive/details/split_list_base.h @@ -25,7 +25,7 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef CDSLIB_INTRUSIVE_DETAILS_SPLIT_LIST_BASE_H @@ -47,7 +47,7 @@ namespace cds { namespace intrusive { /// Split-ordered list node /** Template parameter: - - OrderedListNode - node type for underlying ordered list + - \p OrderedListNode - node type for underlying ordered list */ template struct node: public OrderedListNode @@ -79,13 +79,9 @@ namespace cds { namespace intrusive { } }; - /// SplitListSet internal statistics. May be used for debugging or profiling + /// \p SplitListSet internal statistics. May be used for debugging or profiling /** - Template argument \p Counter defines type of counter. - Default is \p cds::atomicity::event_counter, that is weak, i.e. it is not guaranteed - strict event counting. - You may use stronger type of counter like as \p cds::atomicity::item_counter, - or even integral type, for example, \p int. + Template argument \p Counter defines type of counter, default is \p cds::atomicity::event_counter. */ template struct stat @@ -244,11 +240,11 @@ namespace cds { namespace intrusive { for default type. - \p opt::memory_model - C++ memory model for atomic operations. Can be \p opt::v::relaxed_ordering (relaxed memory model, the default) - or \p opt::v::sequential_consistent (sequentially consisnent memory model). + or \p opt::v::sequential_consistent (sequentially consistent memory model). - \p opt::allocator - optional, bucket table allocator. Default is \ref CDS_DEFAULT_ALLOCATOR. - \p split_list::dynamic_bucket_table - use dynamic or static bucket table implementation. Dynamic bucket table expands its size up to maximum bucket count when necessary - - \p opt::back_off - back-off strategy used for spinning, defult is \p cds::backoff::Default. + - \p opt::back_off - back-off strategy used for spinning, default is \p cds::backoff::Default. - \p opt::stat - internal statistics, default is \p split_list::empty_stat (disabled). To enable internal statistics use \p split_list::stat. */ @@ -615,7 +611,7 @@ namespace cds { namespace intrusive { return static_cast( base_class::to_node_ptr( v ) ); } - /// Convert node refernce to value pointer + /// Convert node reference to value pointer static value_type * to_value_ptr( node_type& n ) { return base_class::to_value_ptr( static_cast( n ) ); diff --git a/cds/intrusive/impl/michael_list.h b/cds/intrusive/impl/michael_list.h index 7f6ab5b0..96b53d52 100644 --- a/cds/intrusive/impl/michael_list.h +++ b/cds/intrusive/impl/michael_list.h @@ -25,7 +25,7 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef CDSLIB_INTRUSIVE_IMPL_MICHAEL_LIST_H diff --git a/cds/intrusive/split_list.h b/cds/intrusive/split_list.h index 832534c7..1b956049 100644 --- a/cds/intrusive/split_list.h +++ b/cds/intrusive/split_list.h @@ -25,7 +25,7 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef CDSLIB_INTRUSIVE_SPLIT_LIST_H diff --git a/cds/opt/options.h b/cds/opt/options.h index 82b0a1fc..f740f024 100644 --- a/cds/opt/options.h +++ b/cds/opt/options.h @@ -25,7 +25,7 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef CDSLIB_OPT_OPTIONS_H -- 2.34.1