From 555e429e34c2a325e262dbb9de157d60a08ca17d Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Sat, 7 Jun 2025 12:01:00 -0400
Subject: Consistently organize data structure documentation

---
 include/zix/btree.h |  8 +++++++-
 include/zix/hash.h  | 14 +++++++-------
 include/zix/ring.h  |  8 +++++++-
 include/zix/tree.h  |  8 +++++++-
 4 files changed, 28 insertions(+), 10 deletions(-)

(limited to 'include')

diff --git a/include/zix/btree.h b/include/zix/btree.h
index f02148d..859e092 100644
--- a/include/zix/btree.h
+++ b/include/zix/btree.h
@@ -21,7 +21,7 @@ ZIX_BEGIN_DECLS
 */
 
 /**
-   @defgroup zix_btree_setup Setup
+   @defgroup zix_btree_types Types
    @{
 */
 
@@ -50,6 +50,12 @@ typedef int (*ZixBTreeCompareFunc)(const void* ZIX_UNSPECIFIED a,
 typedef void (*ZixBTreeDestroyFunc)(void* ZIX_UNSPECIFIED       ptr,
                                     const void* ZIX_UNSPECIFIED user_data);
 
+/**
+   @}
+   @defgroup zix_btree_setup Setup
+   @{
+*/
+
 /**
    Create a new (empty) B-Tree.
 
diff --git a/include/zix/hash.h b/include/zix/hash.h
index ec04b90..3222e58 100644
--- a/include/zix/hash.h
+++ b/include/zix/hash.h
@@ -20,7 +20,7 @@ ZIX_BEGIN_DECLS
 */
 
 /**
-   @defgroup zix_hash_datatypes Datatypes
+   @defgroup zix_hash_types Types
    @{
 */
 
@@ -77,12 +77,6 @@ typedef struct ZixHashImpl ZixHash;
 /// A full hash code for a key which is not folded down to the table size
 typedef size_t ZixHashCode;
 
-/**
-   @}
-   @defgroup zix_hash_setup Setup
-   @{
-*/
-
 /// User function for getting the key of a record
 typedef const ZixHashKey* ZIX_NONNULL (*ZixKeyFunc)(
   const ZixHashRecord* ZIX_NONNULL record);
@@ -94,6 +88,12 @@ typedef ZixHashCode (*ZixHashFunc)(const ZixHashKey* ZIX_NONNULL key);
 typedef bool (*ZixKeyEqualFunc)(const ZixHashKey* ZIX_NONNULL a,
                                 const ZixHashKey* ZIX_NONNULL b);
 
+/**
+   @}
+   @defgroup zix_hash_setup Setup
+   @{
+*/
+
 /**
    Create a new hash table.
 
diff --git a/include/zix/ring.h b/include/zix/ring.h
index d4a1ef2..4431658 100644
--- a/include/zix/ring.h
+++ b/include/zix/ring.h
@@ -19,7 +19,7 @@ ZIX_BEGIN_DECLS
 */
 
 /**
-   @defgroup zix_ring_setup Setup
+   @defgroup zix_ring_types Types
    @{
 */
 
@@ -31,6 +31,12 @@ ZIX_BEGIN_DECLS
 */
 typedef struct ZixRingImpl ZixRing;
 
+/**
+   @}
+   @defgroup zix_ring_setup Setup
+   @{
+*/
+
 /**
    Create a new ring.
 
diff --git a/include/zix/tree.h b/include/zix/tree.h
index 2b3a0e3..7a223a5 100644
--- a/include/zix/tree.h
+++ b/include/zix/tree.h
@@ -20,7 +20,7 @@ ZIX_BEGIN_DECLS
 */
 
 /**
-   @defgroup zix_tree_setup Setup
+   @defgroup zix_tree_types Types
    @{
 */
 
@@ -36,6 +36,12 @@ typedef int (*ZixTreeCompareFunc)(const void* ZIX_UNSPECIFIED a,
 typedef void (*ZixTreeDestroyFunc)(void* ZIX_UNSPECIFIED       ptr,
                                    const void* ZIX_UNSPECIFIED user_data);
 
+/**
+   @}
+   @defgroup zix_tree_setup Setup
+   @{
+*/
+
 /// Create a new (empty) tree
 ZIX_API ZIX_NODISCARD ZixTree* ZIX_ALLOCATED
 zix_tree_new(ZixAllocator* ZIX_NULLABLE      allocator,
-- 
cgit v1.2.1