summaryrefslogtreecommitdiff
path: root/libguile/foreign.c
diff options
context:
space:
mode:
authorBake Timmons <b3timmons@speedymail.org>2012-01-11 23:33:01 -0500
committerAndy Wingo <wingo@pobox.com>2012-02-02 12:22:10 +0100
commitb7e64f8b266651e5b3fae6f664a45468f0c4907f (patch)
tree968302e8ca0b4b4976802426f586b68982ffb01a /libguile/foreign.c
parentc99acbf3978220873235c17a79fb37ef0933f3c6 (diff)
downloadguile-b7e64f8b266651e5b3fae6f664a45468f0c4907f.tar.gz
Improve the usage of variable names in C docstrings.
* libguile/alist.c: * libguile/array-map.c: * libguile/arrays.c: * libguile/bitvectors.c: * libguile/filesys.c: * libguile/foreign.c: * libguile/generalized-arrays.c: * libguile/hashtab.c: * libguile/ioext.c: * libguile/load.c: * libguile/numbers.c: * libguile/ports.c: * libguile/posix.c: * libguile/print.c: * libguile/procprop.c: * libguile/promises.c: * libguile/simpos.c: * libguile/socket.c: * libguile/srfi-1.c: * libguile/srfi-13.c: * libguile/srfi-14.c: * libguile/stacks.c: * libguile/stime.c: * libguile/strings.c: * libguile/struct.c: * libguile/symbols.c: * libguile/threads.c: * libguile/weak-table.c: * libguile/weak-vector.c: Make the variable names in the C docstrings more consistent. Replace a few instances of @var with @code when appropriate.
Diffstat (limited to 'libguile/foreign.c')
-rw-r--r--libguile/foreign.c6
1 files changed, 3 insertions, 3 deletions
diff --git a/libguile/foreign.c b/libguile/foreign.c
index 0dc7ac666..611b08fac 100644
--- a/libguile/foreign.c
+++ b/libguile/foreign.c
@@ -1141,11 +1141,11 @@ invoke_closure (ffi_cif *cif, void *ret, void **args, void *data)
SCM_DEFINE (scm_procedure_to_pointer, "procedure->pointer", 3, 0, 0,
(SCM return_type, SCM proc, SCM arg_types),
- "Return a pointer to a C function of type @var{return-type}\n"
- "taking arguments of types @var{arg-types} (a list) and\n"
+ "Return a pointer to a C function of type @var{return_type}\n"
+ "taking arguments of types @var{arg_types} (a list) and\n"
"behaving as a proxy to procedure @var{proc}. Thus\n"
"@var{proc}'s arity, supported argument types, and return\n"
- "type should match @var{return-type} and @var{arg-types}.\n")
+ "type should match @var{return_type} and @var{arg_types}.\n")
#define FUNC_NAME s_scm_procedure_to_pointer
{
SCM cif_pointer, pointer;