From f61d54e71d63b29e805dc69dc6337f65273440b9 Mon Sep 17 00:00:00 2001 From: ManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com> Date: Mon, 26 Jan 2026 10:24:33 +0100 Subject: Improve documentation of fl_utf8_{next|from}_composed_char() --- src/fl_utf8.cxx | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/src/fl_utf8.cxx b/src/fl_utf8.cxx index b9681108c..81af4a4e7 100644 --- a/src/fl_utf8.cxx +++ b/src/fl_utf8.cxx @@ -1631,14 +1631,15 @@ unsigned fl_utf8from_mb(char* dst, unsigned dstlen, const char* src, unsigned sr /** - Returns pointer to beginning of next unicode character after potentially composed character. - Some unicode characters (example: πŸ‘©β€βœˆοΈ "woman pilot") are composed of several unicode points. They may pair two successive - codepoints with U+200D (zero-width joiner) and may qualify any component with variation selectors or Fitzpatrick emoji modifiers. - Most flag emojis are composed of 2 successive "regional indicator symbols" from range [U+1F1E6 , U+1F1FF]. + Returns pointer to beginning of character after given location in UTF8 string accounting for composed characters. + Some unicode characters (examples: πŸ‘©β€βœˆοΈ "woman pilot", πŸ‡ΈπŸ‡² "San Marino flag") are composed of several unicode points. + They may pair two successive codepoints with U+200D (zero-width joiner) and may qualify any component with + variation selectors or Fitzpatrick emoji modifiers. Most flag emojis are composed of two successive + "regional indicator symbols", each in range [U+1F1E6 , U+1F1FF]. \param from points to a location within a UTF8 string. If this location is inside the UTF8 encoding of a codepoint or is an invalid byte, this function returns \p from + 1. \param end points past last codepoint of the string. - \return pointer to beginning of first codepoint after potentially composed character that begins at \p from. + \return pointer to beginning of first codepoint after possibly composed character that begins at \p from. */ const char *fl_utf8_next_composed_char(const char *from, const char *end) { int skip = fl_utf8len1(*from); @@ -1674,12 +1675,12 @@ const char *fl_utf8_next_composed_char(const char *from, const char *end) { /** - Returns pointer to beginning of previous potentially composed character before given unicode character. + Returns pointer to beginning of character before given location in UTF8 string accounting for composed characters. See fl_utf8_next_composed_char() for a hint about what is a composed unicode character. \param from points to a location within a UTF8 string. If this location is inside the UTF8 encoding of a codepoint or is an invalid byte, this function returns \p from - 1. \param begin points to start of first codepoint of the string. - \return pointer to beginning of first potentially composed character before the codepoint that begins at \p from. + \return pointer to beginning of first possibly composed character before the codepoint that begins at \p from. */ const char *fl_utf8_previous_composed_char(const char *from, const char *begin) { int l = fl_utf8len(*from); -- cgit v1.2.3