summaryrefslogtreecommitdiff
path: root/doc/ref/api-data.texi
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2010-02-10 00:39:25 +0100
committerLudovic Courtès <ludo@gnu.org>2010-02-10 00:40:01 +0100
commit524aa8ae6830d0f471f0c86431d5da87c8a0a534 (patch)
treeffdc82c72afff3569917199b9c15a441123e9835 /doc/ref/api-data.texi
parentdad6817f7d9581264891c6ad8954369d01f3d0b7 (diff)
downloadguile-524aa8ae6830d0f471f0c86431d5da87c8a0a534.tar.gz
Fix documentation of the `string->utf' and `utf->string' functions.
* doc/ref/api-data.texi (Bytevectors as Strings): Describe optional parameter of `string->utf{16,32}' and `utf{16,32}->string'.
Diffstat (limited to 'doc/ref/api-data.texi')
-rwxr-xr-xdoc/ref/api-data.texi24
1 files changed, 14 insertions, 10 deletions
diff --git a/doc/ref/api-data.texi b/doc/ref/api-data.texi
index 64c138110..d413567e5 100755
--- a/doc/ref/api-data.texi
+++ b/doc/ref/api-data.texi
@@ -4422,23 +4422,27 @@ assume that Guile strings are Latin-1-encoded.}.
@end lisp
@deffn {Scheme Procedure} string->utf8 str
-@deffnx {Scheme Procedure} string->utf16 str
-@deffnx {Scheme Procedure} string->utf32 str
+@deffnx {Scheme Procedure} string->utf16 str [endianness]
+@deffnx {Scheme Procedure} string->utf32 str [endianness]
@deffnx {C Function} scm_string_to_utf8 (str)
-@deffnx {C Function} scm_string_to_utf16 (str)
-@deffnx {C Function} scm_string_to_utf32 (str)
+@deffnx {C Function} scm_string_to_utf16 (str, endianness)
+@deffnx {C Function} scm_string_to_utf32 (str, endianness)
Return a newly allocated bytevector that contains the UTF-8, UTF-16, or
-UTF-32 (aka. UCS-4) encoding of @var{str}.
+UTF-32 (aka. UCS-4) encoding of @var{str}. For UTF-16 and UTF-32,
+@var{endianness} should be the symbol @code{big} or @code{little}; when omitted,
+it defaults to big endian.
@end deffn
@deffn {Scheme Procedure} utf8->string utf
-@deffnx {Scheme Procedure} utf16->string utf
-@deffnx {Scheme Procedure} utf32->string utf
+@deffnx {Scheme Procedure} utf16->string utf [endianness]
+@deffnx {Scheme Procedure} utf32->string utf [endianness]
@deffnx {C Function} scm_utf8_to_string (utf)
-@deffnx {C Function} scm_utf16_to_string (utf)
-@deffnx {C Function} scm_utf32_to_string (utf)
+@deffnx {C Function} scm_utf16_to_string (utf, endianness)
+@deffnx {C Function} scm_utf32_to_string (utf, endianness)
Return a newly allocated string that contains from the UTF-8-, UTF-16-,
-or UTF-32-decoded contents of bytevector @var{utf}.
+or UTF-32-decoded contents of bytevector @var{utf}. For UTF-16 and UTF-32,
+@var{endianness} should be the symbol @code{big} or @code{little}; when omitted,
+it defaults to big endian.
@end deffn
@node Bytevectors as Generalized Vectors