Split reference documentation up into groups and add global header

The "global" header just provides a convenient place to define the group
structure of the library.  Applications are better off using the individual
headers, but this one will work fine if you don't care about build times or
precise dependencies.

1 files changed, 61 insertions, 0 deletions

diff --git a/include/zix/zix.h b/include/zix/zix.h
new file mode 100644
index 0000000..02ab31f
--- /dev/null
+++ b/include/zix/zix.h
@@ -0,0 +1,61 @@
+// Copyright 2016-2022 David Robillard <d@drobilla.net>
+// SPDX-License-Identifier: ISC
+
+#ifndef ZIX_ZIX_H
+#define ZIX_ZIX_H
+
+// IWYU pragma: begin_exports
+
+/**
+   @defgroup zix Zix C API
+   @{
+*/
+
+/**
+   @defgroup zix_utilities Utilities
+   @{
+*/
+
+#include "zix/attributes.h"
+#include "zix/digest.h"
+#include "zix/function_types.h"
+#include "zix/status.h"
+
+/**
+   @}
+   @defgroup zix_allocation Allocation
+   @{
+*/
+
+#include "zix/allocator.h"
+#include "zix/bump_allocator.h"
+
+/**
+   @}
+   @defgroup zix_data_structures Data Structures
+   @{
+*/
+
+#include "zix/bitset.h"
+#include "zix/btree.h"
+#include "zix/hash.h"
+#include "zix/ring.h"
+#include "zix/tree.h"
+
+/**
+   @}
+   @defgroup zix_threading Threading
+   @{
+*/
+
+#include "zix/sem.h"
+#include "zix/thread.h"
+
+/**
+   @}
+   @}
+*/
+
+// IWYU pragma: end_exports
+
+#endif /* ZIX_ZIX_H */