From d9e0741aee5ef902c4a4b0ca42167f9b19734e69 Mon Sep 17 00:00:00 2001 From: Takayuki Matsuoka Date: Sat, 6 Aug 2022 19:45:13 +0900 Subject: Add: Doxygen comment for LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION --- lib/lz4.c | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/lib/lz4.c b/lib/lz4.c index 5fae002..6ece5dc 100644 --- a/lib/lz4.c +++ b/lib/lz4.c @@ -188,6 +188,17 @@ /*-************************************ * Memory routines **************************************/ + +/*! LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION : + * Disable relatively high-level LZ4/HC functions that use dynamic memory + * allocation functions (malloc(), calloc(), free()). + * + * Note that this is a compile-time switch. And since it disables + * public/stable LZ4 v1 API functions, we don't recommend using this + * symbol to generate a library for distribution. + * + * The following functions are removed when this symbol is defined. + */ #if defined(LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION) # define ALLOC(s) lz4_error_memory_allocation_is_disabled # define ALLOC_AND_ZERO(s) lz4_error_memory_allocation_is_disabled -- cgit v0.12