diff options
| author | David Robillard <d@drobilla.net> | 2022-10-23 12:30:41 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2022-10-23 12:40:05 -0400 |
| commit | 07b1289cd4907aa3defe3fc600f3db1dcefcb719 (patch) | |
| tree | ffc16da1673cf0d1b7a4980e5b63215dd2143647 /include/zix/bump_allocator.h | |
| parent | aeb1b45effb1eb64761a140544a38ad60c868228 (diff) | |
| download | zix-07b1289cd4907aa3defe3fc600f3db1dcefcb719.tar.gz zix-07b1289cd4907aa3defe3fc600f3db1dcefcb719.tar.bz2 zix-07b1289cd4907aa3defe3fc600f3db1dcefcb719.zip | |
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.
Diffstat (limited to 'include/zix/bump_allocator.h')
| -rw-r--r-- | include/zix/bump_allocator.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/include/zix/bump_allocator.h b/include/zix/bump_allocator.h index bec45c8..c054207 100644 --- a/include/zix/bump_allocator.h +++ b/include/zix/bump_allocator.h @@ -10,6 +10,12 @@ #include <stddef.h> /** + @defgroup bump_allocator Bump Allocator + @ingroup zix_allocation + @{ +*/ + +/** A simple bump-pointer allocator that never frees. This is about the simplest possible allocator that is useful in practice. @@ -50,4 +56,8 @@ ZIX_API ZixBumpAllocator zix_bump_allocator(size_t capacity, void* ZIX_NONNULL buffer); +/** + @} +*/ + #endif // ZIX_BUMP_ALLOCATOR_H |