This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
[v3] hashtable doc tweaks
- From: Benjamin De Kosnik <bkoz at redhat dot com>
- To: libstdc++ at gcc dot gnu dot org, gcc-patches at gcc dot gnu dot org
- Date: Wed, 25 Apr 2012 19:26:52 -0700
- Subject: [v3] hashtable doc tweaks
... putting in line breaks for doxygen, so that each base class is on a
separate line.
-benjamin
2012-04-25 Benjamin Kosnik <bkoz@redhat.com>
* include/bits/hashtable.h: Adjust doxygen markup for base classes.
* include/bits/hashtable_policy.h: Same.
diff --git a/libstdc++-v3/include/bits/hashtable.h b/libstdc++-v3/include/bits/hashtable.h
index 8c17035..5adc7ca 100644
--- a/libstdc++-v3/include/bits/hashtable.h
+++ b/libstdc++-v3/include/bits/hashtable.h
@@ -157,11 +157,11 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
* explicitly passed, template pattern.
*
* Base class templates are:
- * __detail::_Hashtable_base
- * __detail::_Map_base
- * __detail::_Insert
- * __detail::_Rehash_base
- * __detail::_Equality
+ * - __detail::_Hashtable_base
+ * - __detail::_Map_base
+ * - __detail::_Insert
+ * - __detail::_Rehash_base
+ * - __detail::_Equality
*/
template<typename _Key, typename _Value, typename _Alloc,
typename _ExtractKey, typename _Equal,
diff --git a/libstdc++-v3/include/bits/hashtable_policy.h b/libstdc++-v3/include/bits/hashtable_policy.h
index 160a6ce..3b43510 100644
--- a/libstdc++-v3/include/bits/hashtable_policy.h
+++ b/libstdc++-v3/include/bits/hashtable_policy.h
@@ -121,10 +121,10 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
/**
* struct _Hash_node_base
*
- * Nodes, used to wrap elements stored in the hash table. A policy
- * template parameter of class template _Hashtable controls whether
- * nodes also store a hash code. In some cases (e.g. strings) this
- * may be a performance win.
+ * Nodes, used to wrap elements stored in the hash table. A policy
+ * template parameter of class template _Hashtable controls whether
+ * nodes also store a hash code. In some cases (e.g. strings) this
+ * may be a performance win.
*/
struct _Hash_node_base
{
@@ -141,7 +141,11 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
template<typename _Value, bool _Cache_hash_code>
struct _Hash_node;
- /// Specialization.
+ /**
+ * Specialization for nodes with caches, struct _Hash_node.
+ *
+ * Base class is __detail::_Hash_node_base.
+ */
template<typename _Value>
struct _Hash_node<_Value, true> : _Hash_node_base
{
@@ -156,7 +160,11 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
_M_next() const { return static_cast<_Hash_node*>(_M_nxt); }
};
- /// Specialization.
+ /**
+ * Specialization for nodes without caches, struct _Hash_node.
+ *
+ * Base class is __detail::_Hash_node_base.
+ */
template<typename _Value>
struct _Hash_node<_Value, false> : _Hash_node_base
{
@@ -1421,8 +1429,12 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
/**
* Primary class template _Hashtable_base.
*
- * Base class for _Hashtable. Helper class adding management of
- * _Equal functor to _Hash_code_base type.
+ * Helper class adding management of _Equal functor to
+ * _Hash_code_base type.
+ *
+ * Base class templates are:
+ * - __detail::_Hash_code_base
+ * - __detail::_Hashtable_ebo_helper
*/
template<typename _Key, typename _Value,
typename _ExtractKey, typename _Equal,