diff options
author | Bake Timmons <b3timmons@speedymail.org> | 2012-01-11 23:33:01 -0500 |
---|---|---|
committer | Andy Wingo <wingo@pobox.com> | 2012-02-02 12:22:10 +0100 |
commit | b7e64f8b266651e5b3fae6f664a45468f0c4907f (patch) | |
tree | 968302e8ca0b4b4976802426f586b68982ffb01a /libguile/socket.c | |
parent | c99acbf3978220873235c17a79fb37ef0933f3c6 (diff) | |
download | guile-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/socket.c')
-rw-r--r-- | libguile/socket.c | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/libguile/socket.c b/libguile/socket.c index 7d0049b1c..23143779a 100644 --- a/libguile/socket.c +++ b/libguile/socket.c @@ -519,10 +519,10 @@ SCM_DEFINE (scm_getsockopt, "getsockopt", 3, 0, 0, "@end defvar\n" "\n" "@defvar SO_LINGER\n" - "The @var{value} returned is a pair of integers\n" - "@code{(@var{ENABLE} . @var{TIMEOUT})}. On old systems without\n" + "The value returned is a pair of integers\n" + "@code{(@var{enable} . @var{timeout})}. On old systems without\n" "timeout support (ie.@: without @code{struct linger}), only\n" - "@var{ENABLE} has an effect but the value in Guile is always a\n" + "@var{enable} has an effect but the value in Guile is always a\n" "pair.\n" "@end defvar") #define FUNC_NAME s_scm_getsockopt @@ -1632,7 +1632,7 @@ SCM_DEFINE (scm_sendto, "sendto", 3, 1, 1, (SCM sock, SCM message, SCM fam_or_sockaddr, SCM address, SCM args_and_flags), "Transmit bytevector @var{message} on socket port\n" "@var{sock}. The\n" - "destination address is specified using the @var{fam},\n" + "destination address is specified using the @var{fam_or_sockaddr},\n" "@var{address} and\n" "@var{args_and_flags} arguments, or just a socket address object " "returned by @code{make-socket-address}, in a similar way to the\n" |