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/generalized-arrays.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/generalized-arrays.c')
-rw-r--r-- | libguile/generalized-arrays.c | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/libguile/generalized-arrays.c b/libguile/generalized-arrays.c index a04b5faa1..3a0ce25c7 100644 --- a/libguile/generalized-arrays.c +++ b/libguile/generalized-arrays.c @@ -198,7 +198,7 @@ SCM_DEFINE (scm_array_in_bounds_p, "array-in-bounds?", 1, 0, 1, SCM_DEFINE (scm_array_ref, "array-ref", 1, 0, 1, (SCM v, SCM args), "Return the element at the @code{(index1, index2)} element in\n" - "@var{array}.") + "array @var{v}.") #define FUNC_NAME s_scm_array_ref { scm_t_array_handle handle; @@ -214,8 +214,9 @@ SCM_DEFINE (scm_array_ref, "array-ref", 1, 0, 1, SCM_DEFINE (scm_array_set_x, "array-set!", 2, 0, 1, (SCM v, SCM obj, SCM args), - "Set the element at the @code{(index1, index2)} element in @var{array} to\n" - "@var{new-value}. The value returned by array-set! is unspecified.") + "Set the element at the @code{(index1, index2)} element in array\n" + "@var{v} to @var{obj}. The value returned by @code{array-set!}\n" + "is unspecified.") #define FUNC_NAME s_scm_array_set_x { scm_t_array_handle handle; |