summaryrefslogtreecommitdiff
path: root/docs/u8c_u8dec.3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/u8c_u8dec.3')
-rw-r--r--docs/u8c_u8dec.327
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/u8c_u8dec.3 b/docs/u8c_u8dec.3
new file mode 100644
index 0000000..2afe4dd
--- /dev/null
+++ b/docs/u8c_u8dec.3
@@ -0,0 +1,27 @@
+.\" Automatically generated by Pandoc 2.14.0.2
+.\"
+.TH "" "" "" "" ""
+.hy
+.SH NAME
+.PP
+u8c_u8dec - UTF-8 decode - Convert an UTF-8 string to UTF-32.
+.SH DECLARATION
+.IP
+.nf
+\f[C]
+# include <stdbool.h>
+# include <stddef.h>
+# include <uchar.h>
+extern bool u8c_u8dec(size_t * const sz,char32_t const * * const out,unsigned char const * const in);
+\f[R]
+.fi
+.SH DESCRIPTION
+.PP
+The function \f[C]u8c_u8dec\f[R] converts the given UTF-8 string
+(\f[I]in\f[R]) to UTF-32 (\f[I]out\f[R]).
+.PP
+The size of the output string (excluding the null-terminator) is placed
+into \f[I]sz\f[R], if [\f[I]sz\f[R]] is not equal to \f[I]NULL\f[R].
+.SH VERSION
+.PP
+u8c 0