From 6c59c4729486bc4340ed67b97eb9a142193815ab Mon Sep 17 00:00:00 2001 From: =?utf8?q?Ludovic=20Court=C3=A8s?= Date: Mon, 6 Apr 2009 23:20:31 +0200 Subject: [PATCH] doc: Document endianness constructs. * doc/api-r6rs.texi (Bytevector Endianness): Document `endianness', and `scm_r6rs_endianness_{big,little}'. --- doc/api-r6rs.texi | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/api-r6rs.texi b/doc/api-r6rs.texi index e8b54fd..229d688 100644 --- a/doc/api-r6rs.texi +++ b/doc/api-r6rs.texi @@ -50,6 +50,17 @@ endianness of the machine it runs on. Return a value denoting the native endianness of the host machine. @end deffn +@deffn {Scheme Macro} endianness symbol +Return an object denoting the endianness specified by @var{symbol}. If +@var{symbol} is neither @code{big} nor @code{little} then a compile-time +error is raised. +@end deffn + +@defvr {C Variable} scm_r6rs_endianness_big +@defvrx {C Variable} scm_r6rs_endianness_little +The objects denoting big (resp. little) endianness. +@end defvr + @node Bytevector Manipulation @subsection Manipulating Bytevectors -- 2.11.4.GIT