summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2009-04-05 13:39:57 +0200
committerBruno Haible <bruno@clisp.org>2009-04-05 13:39:57 +0200
commitcf8d52684a4e67255d8db3e3a21c80194d1f2246 (patch)
treed246c9af54317a526b75fc13a2cea535804a95ef /doc
parentd0b416b9712efacbe880473f9a0c32397f326298 (diff)
downloadlibunistring-cf8d52684a4e67255d8db3e3a21c80194d1f2246.tar.gz
Documentation of <unitypes.h>.
Diffstat (limited to 'doc')
-rw-r--r--doc/unitypes.texi15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/unitypes.texi b/doc/unitypes.texi
new file mode 100644
index 0000000..696ba88
--- /dev/null
+++ b/doc/unitypes.texi
@@ -0,0 +1,15 @@
+@node unitypes.h
+@chapter Elementary types @code{<unitypes.h>}
+
+The include file @code{<unitypes.h>} provides the following basic types.
+
+@deftp Type uint8_t
+@deftpx Type uint16_t
+@deftpx Type uint32_t
+These are the storage units of UTF-8/16/32 strings, respectively. The definitions are
+taken from @code{<stdint.h>}, on platforms where this include file is present.
+@end deftp
+
+@deftp Type ucs4_t
+This type represents a single Unicode character, outside of an UTF-32 string.
+@end deftp