diff options
author | Takayuki Matsuoka <t-mat@users.noreply.github.com> | 2022-08-06 10:45:13 (GMT) |
---|---|---|
committer | Takayuki Matsuoka <t-mat@users.noreply.github.com> | 2022-08-06 10:45:13 (GMT) |
commit | d9e0741aee5ef902c4a4b0ca42167f9b19734e69 (patch) | |
tree | d5528c2f08076e0fd19c5132ea2d8bdecc649126 | |
parent | ca26930a91e5b1d47d725b1043e1f5282fd18aaf (diff) | |
download | lz4-d9e0741aee5ef902c4a4b0ca42167f9b19734e69.zip lz4-d9e0741aee5ef902c4a4b0ca42167f9b19734e69.tar.gz lz4-d9e0741aee5ef902c4a4b0ca42167f9b19734e69.tar.bz2 |
Add: Doxygen comment for LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION
-rw-r--r-- | lib/lz4.c | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -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 |