diff options
author | Bake Timmons <b3timmons@speedymail.org> | 2012-01-15 22:18:08 -0500 |
---|---|---|
committer | Andy Wingo <wingo@pobox.com> | 2012-02-04 00:10:14 +0100 |
commit | 5f6ffd66523e4777ed90348b86296ca6715013bf (patch) | |
tree | 78fca16d43549d819aab87d0e7cbd643d5ff7bfb /doc/ref/api-data.texi | |
parent | 5556c17511ce19f6dfa9fc6cef0e12cf90282e9b (diff) | |
download | guile-5f6ffd66523e4777ed90348b86296ca6715013bf.tar.gz |
Improve consistency of definitions of C functions in manual.
* doc/ref/api-compound.texi
* doc/ref/api-evaluation.texi
* doc/ref/api-foreign.texi
* doc/ref/api-io.texi
* doc/ref/posix.texi
* doc/ref/srfi-modules.texi: Add missing parentheses and commas to definitions
of C functions.
* doc/ref/api-data.texi: Change from @deffn to @deftypefn for C function
with arguments not of SCM type.
Diffstat (limited to 'doc/ref/api-data.texi')
-rw-r--r-- | doc/ref/api-data.texi | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/ref/api-data.texi b/doc/ref/api-data.texi index c485811fa..4fc11c81d 100644 --- a/doc/ref/api-data.texi +++ b/doc/ref/api-data.texi @@ -5260,15 +5260,15 @@ When you want to do more from C, you should convert between symbols and strings using @code{scm_symbol_to_string} and @code{scm_string_to_symbol} and work with the strings. -@deffn {C Function} scm_from_latin1_symbol (const char *name) -@deffnx {C Function} scm_from_utf8_symbol (const char *name) +@deftypefn {C Function} scm_from_latin1_symbol (const char *name) +@deftypefnx {C Function} scm_from_utf8_symbol (const char *name) Construct and return a Scheme symbol whose name is specified by the null-terminated C string @var{name}. These are appropriate when the C string is hard-coded in the source code. -@end deffn +@end deftypefn -@deffn {C Function} scm_from_locale_symbol (const char *name) -@deffnx {C Function} scm_from_locale_symboln (const char *name, size_t len) +@deftypefn {C Function} scm_from_locale_symbol (const char *name) +@deftypefnx {C Function} scm_from_locale_symboln (const char *name, size_t len) Construct and return a Scheme symbol whose name is specified by @var{name}. For @code{scm_from_locale_symbol}, @var{name} must be null terminated; for @code{scm_from_locale_symboln} the length of @var{name} is @@ -5278,7 +5278,7 @@ Note that these functions should @emph{not} be used when @var{name} is a C string constant, because there is no guarantee that the current locale will match that of the source code. In such cases, use @code{scm_from_latin1_symbol} or @code{scm_from_utf8_symbol}. -@end deffn +@end deftypefn @deftypefn {C Function} SCM scm_take_locale_symbol (char *str) @deftypefnx {C Function} SCM scm_take_locale_symboln (char *str, size_t len) |