diff options
| author | Bruno Haible <bruno@clisp.org> | 2017-12-11 03:16:16 +0100 |
|---|---|---|
| committer | Bruno Haible <bruno@clisp.org> | 2017-12-11 03:16:42 +0100 |
| commit | 66423d10dedd2e1391cac7031bb00271694fafcb (patch) | |
| tree | 09240fc93dadfa82ff93e7a69526db5ffcd5cc83 /doc/unitypes.texi | |
| parent | b227d76bef2ac9939548d2ed0b3cba8ac5a9ef3c (diff) | |
| download | libunistring-66423d10dedd2e1391cac7031bb00271694fafcb.tar.gz | |
Documentation updates.
Mostly based on feedback by Richard Stallman <rms@gnu.org>.
Diffstat (limited to 'doc/unitypes.texi')
| -rw-r--r-- | doc/unitypes.texi | 12 |
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 |