7171/** The MAJOR version number (increased when backwards API compatibility is broken). */
7272#define UTF8PROC_VERSION_MAJOR 2
7373/** The MINOR version number (increased when new functionality is added in a backwards-compatible manner). */
74- #define UTF8PROC_VERSION_MINOR 10
74+ #define UTF8PROC_VERSION_MINOR 11
7575/** The PATCH version (increased for fixes that do not change the API). */
7676#define UTF8PROC_VERSION_PATCH 0
7777/** @} */
@@ -150,7 +150,7 @@ typedef enum {
150150 UTF8PROC_STABLE = (1 <<1 ),
151151 /** Compatibility decomposition (i.e. formatting information is lost). */
152152 UTF8PROC_COMPAT = (1 <<2 ),
153- /** Return a result with decomposed characters. */
153+ /** Return a result with composed characters. */
154154 UTF8PROC_COMPOSE = (1 <<3 ),
155155 /** Return a result with decomposed characters. */
156156 UTF8PROC_DECOMPOSE = (1 <<4 ),
@@ -517,7 +517,7 @@ UTF8PROC_DLLEXPORT const utf8proc_property_t *utf8proc_get_property(utf8proc_int
517517 * @param dst the destination buffer.
518518 * @param bufsize the size of the destination buffer.
519519 * @param options one or more of the following flags:
520- * - @ref UTF8PROC_REJECTNA - return an error `codepoint` is unassigned
520+ * - @ref UTF8PROC_REJECTNA - return an error if `codepoint` is unassigned
521521 * - @ref UTF8PROC_IGNORE - strip "default ignorable" codepoints
522522 * - @ref UTF8PROC_CASEFOLD - apply Unicode casefolding
523523 * - @ref UTF8PROC_COMPAT - replace certain codepoints with their
@@ -532,6 +532,11 @@ UTF8PROC_DLLEXPORT const utf8proc_property_t *utf8proc_get_property(utf8proc_int
532532 * option is used. If the string is being processed in order, this can be initialized to 0 for
533533 * the beginning of the string, and is thereafter updated automatically. Otherwise, this parameter is ignored.
534534 *
535+ * In the current version of utf8proc, the maximum destination buffer with the @ref UTF8PROC_DECOMPOSE
536+ * option is 4 elements (or double that with @ref UTF8PROC_CHARBOUND), so this is a good default size.
537+ * However, this may increase in future Unicode versions, so you should always check the return value
538+ * as described below.
539+ *
535540 * @return
536541 * In case of success, the number of codepoints written is returned; in case
537542 * of an error, a negative error code is returned (utf8proc_errmsg()).
0 commit comments