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/ioext.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/ioext.c')
-rw-r--r-- | libguile/ioext.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/libguile/ioext.c b/libguile/ioext.c index 6b0c9b88c..089ef1a01 100644 --- a/libguile/ioext.c +++ b/libguile/ioext.c @@ -49,7 +49,7 @@ SCM_DEFINE (scm_ftell, "ftell", 1, 0, 0, (SCM fd_port), "Return an integer representing the current position of\n" - "@var{fd/port}, measured from the beginning. Equivalent to:\n" + "@var{fd_port}, measured from the beginning. Equivalent to:\n" "\n" "@lisp\n" "(seek port 0 SEEK_CUR)\n" @@ -63,8 +63,8 @@ SCM_DEFINE (scm_ftell, "ftell", 1, 0, 0, SCM_DEFINE (scm_redirect_port, "redirect-port", 2, 0, 0, (SCM old, SCM new), "This procedure takes two ports and duplicates the underlying file\n" - "descriptor from @var{old-port} into @var{new-port}. The\n" - "current file descriptor in @var{new-port} will be closed.\n" + "descriptor from @var{old} into @var{new}. The\n" + "current file descriptor in @var{new} will be closed.\n" "After the redirection the two ports will share a file position\n" "and file status flags.\n\n" "The return value is unspecified.\n\n" @@ -236,7 +236,7 @@ SCM_DEFINE (scm_fdopen, "fdopen", 2, 0, 0, SCM_DEFINE (scm_primitive_move_to_fdes, "primitive-move->fdes", 2, 0, 0, (SCM port, SCM fd), "Moves the underlying file descriptor for @var{port} to the integer\n" - "value @var{fdes} without changing the revealed count of @var{port}.\n" + "value @var{fd} without changing the revealed count of @var{port}.\n" "Any other ports already using this descriptor will be automatically\n" "shifted to new descriptors and their revealed counts reset to zero.\n" "The return value is @code{#f} if the file descriptor already had the\n" @@ -284,7 +284,7 @@ get_matching_port (void *closure, SCM port, SCM val, SCM result) /* Return a list of ports using a given file descriptor. */ SCM_DEFINE (scm_fdes_to_ports, "fdes->ports", 1, 0, 0, (SCM fd), - "Return a list of existing ports which have @var{fdes} as an\n" + "Return a list of existing ports which have @var{fd} as an\n" "underlying file descriptor, without changing their revealed\n" "counts.") #define FUNC_NAME s_scm_fdes_to_ports |