summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2025-06-07 12:01:00 -0400
committerDavid Robillard <d@drobilla.net>2025-06-07 12:01:00 -0400
commit555e429e34c2a325e262dbb9de157d60a08ca17d (patch)
treed2b4381be4b81a3abd70429f71587432123c233e
parent94efd15ff9fdfaeab42dbfca9f3a2aa1f2f40d46 (diff)
downloadzix-555e429e34c2a325e262dbb9de157d60a08ca17d.tar.gz
zix-555e429e34c2a325e262dbb9de157d60a08ca17d.tar.bz2
zix-555e429e34c2a325e262dbb9de157d60a08ca17d.zip
Consistently organize data structure documentation
-rw-r--r--doc/xml/meson.build5
-rw-r--r--include/zix/btree.h8
-rw-r--r--include/zix/hash.h14
-rw-r--r--include/zix/ring.h8
-rw-r--r--include/zix/tree.h8
5 files changed, 32 insertions, 11 deletions
diff --git a/doc/xml/meson.build b/doc/xml/meson.build
index c1b681c..f5a6b1d 100644
--- a/doc/xml/meson.build
+++ b/doc/xml/meson.build
@@ -36,6 +36,7 @@ doxygen_xml = custom_target(
'group__zix__btree__modification.xml',
'group__zix__btree__searching.xml',
'group__zix__btree__setup.xml',
+ 'group__zix__btree__types.xml',
'group__zix__data__structures.xml',
'group__zix__digest.xml',
'group__zix__environment.xml',
@@ -49,11 +50,11 @@ doxygen_xml = custom_target(
'group__zix__fs__queries.xml',
'group__zix__fs__resolution.xml',
'group__zix__hash.xml',
- 'group__zix__hash__datatypes.xml',
'group__zix__hash__iteration.xml',
'group__zix__hash__modification.xml',
'group__zix__hash__searching.xml',
'group__zix__hash__setup.xml',
+ 'group__zix__hash__types.xml',
'group__zix__path.xml',
'group__zix__path__concatenation.xml',
'group__zix__path__decomposition.xml',
@@ -62,6 +63,7 @@ doxygen_xml = custom_target(
'group__zix__ring.xml',
'group__zix__ring__read.xml',
'group__zix__ring__setup.xml',
+ 'group__zix__ring__types.xml',
'group__zix__ring__write.xml',
'group__zix__sem.xml',
'group__zix__status.xml',
@@ -73,6 +75,7 @@ doxygen_xml = custom_target(
'group__zix__tree__modification.xml',
'group__zix__tree__searching.xml',
'group__zix__tree__setup.xml',
+ 'group__zix__tree__types.xml',
'group__zix__utilities.xml',
'hash_8h.xml',
'path_8h.xml',
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
@{
*/
@@ -51,6 +51,12 @@ typedef void (*ZixBTreeDestroyFunc)(void* ZIX_UNSPECIFIED ptr,
const void* ZIX_UNSPECIFIED user_data);
/**
+ @}
+ @defgroup zix_btree_setup Setup
+ @{
+*/
+
+/**
Create a new (empty) B-Tree.
The given comparator must be a total ordering and is used to internally
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);
@@ -95,6 +89,12 @@ typedef bool (*ZixKeyEqualFunc)(const ZixHashKey* ZIX_NONNULL a,
const ZixHashKey* ZIX_NONNULL b);
/**
+ @}
+ @defgroup zix_hash_setup Setup
+ @{
+*/
+
+/**
Create a new hash table.
@param allocator Allocator used for the internal array.
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
@{
*/
@@ -32,6 +32,12 @@ ZIX_BEGIN_DECLS
typedef struct ZixRingImpl ZixRing;
/**
+ @}
+ @defgroup zix_ring_setup Setup
+ @{
+*/
+
+/**
Create a new ring.
@param allocator Allocator for the ring object and its array.
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,