summaryrefslogtreecommitdiff
path: root/doc/unitypes.texi
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff.email>2018-07-08 23:15:22 +0200
committerJörg Frings-Fürst <debian@jff.email>2018-07-08 23:15:22 +0200
commit853c9cf3718db7c9f6d723e45031016231e1cbd1 (patch)
treee6a5cafe819de3d14665da32bfd87259b089ec02 /doc/unitypes.texi
parent7b350538dddb27a4513158cb6b6405b85f175ad1 (diff)
parent10bd216b0099d2ae8cb22c664fb725165096f95c (diff)
Merge branch 'release/debian/0.9.10-1'debian/0.9.10-1
Diffstat (limited to 'doc/unitypes.texi')
-rw-r--r--doc/unitypes.texi12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/unitypes.texi b/doc/unitypes.texi
index 696ba88..68ab92f 100644
--- a/doc/unitypes.texi
+++ b/doc/unitypes.texi
@@ -13,3 +13,15 @@ taken from @code{<stdint.h>}, on platforms where this include file is present.
@deftp Type ucs4_t
This type represents a single Unicode character, outside of an UTF-32 string.
@end deftp
+
+The types @code{ucs4_t} and @code{uint32_t} happen to be identical. They differ
+in use and intent, however:
+@itemize @bullet
+@item
+Use @code{uint32_t *} to designate an UTF-32 string. Use @code{ucs4_t} to
+designate a single Unicode character, outside of an UTF-32 string.
+@item
+Conversions functions that take an UTF-32 string as input will usually perform
+a range-check on the @code{uint32_t} values. Whereas functions that are
+declared to take @code{ucs4_t} arguments will not perform such a range-check.
+@end itemize