Fixed recursive links in docs
authorkhizmax <libcds.dev@gmail.com>
Sat, 9 Jan 2016 09:19:22 +0000 (12:19 +0300)
committerkhizmax <libcds.dev@gmail.com>
Sat, 9 Jan 2016 09:19:22 +0000 (12:19 +0300)
cds/container/feldman_hashmap_rcu.h
cds/container/feldman_hashset_rcu.h
cds/container/impl/feldman_hashmap.h
cds/container/impl/feldman_hashset.h
cds/intrusive/feldman_hashset_rcu.h
cds/intrusive/impl/feldman_hashset.h

index 190b09749894bb5a75fb363e04963ca4bc8817a9..15291c6fcf27c0e52b50adb3ef6077f033e0923a 100644 (file)
@@ -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
         {
index 99f8f2ea0c8fd2a853353f7bef6ef7d3a7a0f025..1975e7b04151882375a85c0a838d6d51ae0529f0 100644 (file)
@@ -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
         {
index 9901161e0ca4f7d8cfa956cdb79d23be2984f832..1dc2d662e268fab16236a88fde7c6f3b2d09888a 100644 (file)
@@ -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
         {
index f995bde8e3fe6b6510a716a195919377201cdaea..d6139d14f0b90a4d7006bded56e8f10cc3bf494a 100644 (file)
@@ -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
         {
index 64a66ba40fc773d2adbb1e241ba2dceb6013e4cf..8b61fe4a7384c0c83d08bdc45fcd099237864030 100644 (file)
@@ -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<feldman_hashset::level_statistics>& stat) const
         {
index 75d8aa13d1056ec17a61cf053d7dd57daced91fc..143a14325bc6118126936a89b4efbaca6c880829 100644 (file)
@@ -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.