From a7a311cd15d7d8f587984a59306f4ffd04b21b16 Mon Sep 17 00:00:00 2001 From: khizmax Date: Sat, 9 Jan 2016 12:19:22 +0300 Subject: [PATCH] Fixed recursive links in docs --- cds/container/feldman_hashmap_rcu.h | 8 +++++++- cds/container/feldman_hashset_rcu.h | 8 +++++++- cds/container/impl/feldman_hashmap.h | 8 +++++++- cds/container/impl/feldman_hashset.h | 8 +++++++- cds/intrusive/feldman_hashset_rcu.h | 8 +++++++- cds/intrusive/impl/feldman_hashset.h | 2 +- 6 files changed, 36 insertions(+), 6 deletions(-) diff --git a/cds/container/feldman_hashmap_rcu.h b/cds/container/feldman_hashmap_rcu.h index 190b0974..15291c6f 100644 --- a/cds/container/feldman_hashmap_rcu.h +++ b/cds/container/feldman_hashmap_rcu.h @@ -668,7 +668,13 @@ namespace cds { namespace container { } /// Collects tree level statistics into \p stat - /** @copydetails cds::intrusive::FeldmanHashSet::get_level_statistics + /** + The function traverses the set and collects staistics for each level of the tree + into \p feldman_hashset::level_statistics struct. The element of \p stat[i] + represents statistics for level \p i, level 0 is head array. + The function is thread-safe and may be called in multi-threaded environment. + + Result can be useful for estimating efficiency of hash functor you use. */ void get_level_statistics(std::vector< feldman_hashmap::level_statistics>& stat) const { diff --git a/cds/container/feldman_hashset_rcu.h b/cds/container/feldman_hashset_rcu.h index 99f8f2ea..1975e7b0 100644 --- a/cds/container/feldman_hashset_rcu.h +++ b/cds/container/feldman_hashset_rcu.h @@ -425,7 +425,13 @@ namespace cds { namespace container { } /// Collects tree level statistics into \p stat - /** @copydetails cds::intrusive::FeldmanHashSet::get_level_statistics + /** + The function traverses the set and collects staistics for each level of the tree + into \p feldman_hashset::level_statistics struct. The element of \p stat[i] + represents statistics for level \p i, level 0 is head array. + The function is thread-safe and may be called in multi-threaded environment. + + Result can be useful for estimating efficiency of hash functor you use. */ void get_level_statistics(std::vector< feldman_hashset::level_statistics>& stat) const { diff --git a/cds/container/impl/feldman_hashmap.h b/cds/container/impl/feldman_hashmap.h index 9901161e..1dc2d662 100644 --- a/cds/container/impl/feldman_hashmap.h +++ b/cds/container/impl/feldman_hashmap.h @@ -708,7 +708,13 @@ namespace cds { namespace container { } /// Collects tree level statistics into \p stat - /** @copydetails cds::intrusive::FeldmanHashSet::get_level_statistics + /** + The function traverses the set and collects staistics for each level of the tree + into \p feldman_hashset::level_statistics struct. The element of \p stat[i] + represents statistics for level \p i, level 0 is head array. + The function is thread-safe and may be called in multi-threaded environment. + + Result can be useful for estimating efficiency of hash functor you use. */ void get_level_statistics(std::vector< feldman_hashmap::level_statistics>& stat) const { diff --git a/cds/container/impl/feldman_hashset.h b/cds/container/impl/feldman_hashset.h index f995bde8..d6139d14 100644 --- a/cds/container/impl/feldman_hashset.h +++ b/cds/container/impl/feldman_hashset.h @@ -466,7 +466,13 @@ namespace cds { namespace container { } /// Collects tree level statistics into \p stat - /** @copydetails cds::intrusive::FeldmanHashSet::get_level_statistics + /** + The function traverses the set and collects staistics for each level of the tree + into \p feldman_hashset::level_statistics struct. The element of \p stat[i] + represents statistics for level \p i, level 0 is head array. + The function is thread-safe and may be called in multi-threaded environment. + + Result can be useful for estimating efficiency of hash functor you use. */ void get_level_statistics(std::vector< feldman_hashset::level_statistics>& stat) const { diff --git a/cds/intrusive/feldman_hashset_rcu.h b/cds/intrusive/feldman_hashset_rcu.h index 64a66ba4..8b61fe4a 100644 --- a/cds/intrusive/feldman_hashset_rcu.h +++ b/cds/intrusive/feldman_hashset_rcu.h @@ -496,7 +496,13 @@ namespace cds { namespace intrusive { using base_class::array_node_size; /// Collects tree level statistics into \p stat - /** @copydetails cds::intrusive::FeldmanHashSet::get_level_statistics + /** + The function traverses the set and collects staistics for each level of the tree + into \p feldman_hashset::level_statistics struct. The element of \p stat[i] + represents statistics for level \p i, level 0 is head array. + The function is thread-safe and may be called in multi-threaded environment. + + Result can be useful for estimating efficiency of hash functor you use. */ void get_level_statistics(std::vector& stat) const { diff --git a/cds/intrusive/impl/feldman_hashset.h b/cds/intrusive/impl/feldman_hashset.h index 75d8aa13..143a1432 100644 --- a/cds/intrusive/impl/feldman_hashset.h +++ b/cds/intrusive/impl/feldman_hashset.h @@ -909,7 +909,7 @@ namespace cds { namespace intrusive { using base_class::array_node_size; /// Collects tree level statistics into \p stat - /** @anchor cds_intrusive_FeldmanHashSet_hp_get_level_statistics + /** The function traverses the set and collects staistics for each level of the tree into \p feldman_hashset::level_statistics struct. The element of \p stat[i] represents statistics for level \p i, level 0 is head array. -- 2.34.1