[glibmm/glibmm-2-64] Glib::BalancedTree docs: Recommend std::map or std::unordered_map



commit b8fb858381c84d450ab0b9ae3e9cef94cc2241f3
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Mon Sep 7 16:10:52 2020 +0200

    Glib::BalancedTree docs: Recommend std::map or std::unordered_map

 glib/src/balancedtree.hg | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
---
diff --git a/glib/src/balancedtree.hg b/glib/src/balancedtree.hg
index ce69ace6..9eb58fe6 100644
--- a/glib/src/balancedtree.hg
+++ b/glib/src/balancedtree.hg
@@ -43,12 +43,14 @@ namespace Glib
  * Any type to be used with this template must implement copy constructor.
  * Compiler-generated implementations are OK, provided they do the right
  * thing for the type. Both keys and values are stored in the balanced binary
- * tree as copies, created by copy contructors.
+ * tree as copies, created by copy constructors.
  *
  * Type of key to be used with this template must implement:
  * - less than operator
  * - greater than operator
  *
+ * @note In most cases std::map or std::unordered_map is preferable.
+ *
  * @newin{2,24}
  */
 template <typename K, typename V>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]