summaryrefslogtreecommitdiffstats
path: root/include/zix/allocator.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2022-10-23 12:17:22 -0400
committerDavid Robillard <d@drobilla.net>2022-10-23 12:18:16 -0400
commit6a182f6da1afda96de93467aa15827cefdad40af (patch)
tree3d323b3984a19fbde9a04ab49268e41c6f6c0ca9 /include/zix/allocator.h
parent03554253ae5dbdd12d619db81864b38d5e300171 (diff)
downloadzix-6a182f6da1afda96de93467aa15827cefdad40af.tar.gz
zix-6a182f6da1afda96de93467aa15827cefdad40af.tar.bz2
zix-6a182f6da1afda96de93467aa15827cefdad40af.zip
Add missing documentation
Diffstat (limited to 'include/zix/allocator.h')
-rw-r--r--include/zix/allocator.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/include/zix/allocator.h b/include/zix/allocator.h
index 26db6d3..34ee091 100644
--- a/include/zix/allocator.h
+++ b/include/zix/allocator.h
@@ -96,12 +96,12 @@ typedef void (*ZixAlignedFreeFunc)( //
/// Definition of ZixAllocator
struct ZixAllocatorImpl {
- ZixMallocFunc ZIX_NONNULL malloc;
- ZixCallocFunc ZIX_NONNULL calloc;
- ZixReallocFunc ZIX_NONNULL realloc;
- ZixFreeFunc ZIX_NONNULL free;
- ZixAlignedAllocFunc ZIX_NONNULL aligned_alloc;
- ZixAlignedFreeFunc ZIX_NONNULL aligned_free;
+ ZixMallocFunc ZIX_NONNULL malloc; ///< Allocate
+ ZixCallocFunc ZIX_NONNULL calloc; ///< Allocate and zero
+ ZixReallocFunc ZIX_NONNULL realloc; ///< Reallocate
+ ZixFreeFunc ZIX_NONNULL free; ///< Free
+ ZixAlignedAllocFunc ZIX_NONNULL aligned_alloc; ///< Allocate aligned
+ ZixAlignedFreeFunc ZIX_NONNULL aligned_free; ///< Free aligned
};
/// Return the default allocator which simply uses the system allocator