From 1111d73278e6e9e552fd386b947a374da9398aaa Mon Sep 17 00:00:00 2001 From: "Steven G. Johnson" Date: Thu, 13 Nov 2025 15:02:48 -0500 Subject: [PATCH] document that utf8proc_map simply wraps utf8proc_decompose and utf8proc_reencode --- utf8proc.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/utf8proc.h b/utf8proc.h index 569a21d..3c683a4 100644 --- a/utf8proc.h +++ b/utf8proc.h @@ -748,6 +748,10 @@ UTF8PROC_DLLEXPORT const char *utf8proc_category_string(utf8proc_int32_t codepoi * * @note The memory of the new UTF-8 string will have been allocated * with `malloc`, and should therefore be deallocated with `free`. + * + * @note `utf8proc_map` simply calls `utf8proc_decompose` followed by `utf8proc_reencode`, + * and applications requiring greater control over memory allocation should instead call + * those two functions directly. */ UTF8PROC_DLLEXPORT utf8proc_ssize_t utf8proc_map( const utf8proc_uint8_t *str, utf8proc_ssize_t strlen, utf8proc_uint8_t **dstptr, utf8proc_option_t options