Skip to content

Commit ae2f2fb

Browse files
authored
document that utf8proc_map simply wraps utf8proc_decompose and utf8proc_reencode (#312)
1 parent d7f3ec1 commit ae2f2fb

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

utf8proc.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -750,6 +750,10 @@ UTF8PROC_DLLEXPORT const char *utf8proc_category_string(utf8proc_int32_t codepoi
750750
*
751751
* @note The memory of the new UTF-8 string will have been allocated
752752
* with `malloc`, and should therefore be deallocated with `free`.
753+
*
754+
* @note `utf8proc_map` simply calls `utf8proc_decompose` followed by `utf8proc_reencode`,
755+
* and applications requiring greater control over memory allocation should instead call
756+
* those two functions directly.
753757
*/
754758
UTF8PROC_DLLEXPORT utf8proc_ssize_t utf8proc_map(
755759
const utf8proc_uint8_t *str, utf8proc_ssize_t strlen, utf8proc_uint8_t **dstptr, utf8proc_option_t options

0 commit comments

Comments
 (0)