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/hashtab.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/hashtab.c')
-rw-r--r-- | libguile/hashtab.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/libguile/hashtab.c b/libguile/hashtab.c index f337ebf8a..fe718b9c8 100644 --- a/libguile/hashtab.c +++ b/libguile/hashtab.c @@ -923,7 +923,7 @@ SCM_DEFINE (scm_hashq_ref, "hashq-ref", 2, 1, 0, (SCM table, SCM key, SCM dflt), "Look up @var{key} in the hash table @var{table}, and return the\n" "value (if any) associated with it. If @var{key} is not found,\n" - "return @var{default} (or @code{#f} if no @var{default} argument\n" + "return @var{dflt} (or @code{#f} if no @var{dflt} argument\n" "is supplied). Uses @code{eq?} for equality testing.") #define FUNC_NAME s_scm_hashq_ref { @@ -941,7 +941,7 @@ SCM_DEFINE (scm_hashq_ref, "hashq-ref", 2, 1, 0, SCM_DEFINE (scm_hashq_set_x, "hashq-set!", 3, 0, 0, (SCM table, SCM key, SCM val), "Find the entry in @var{table} associated with @var{key}, and\n" - "store @var{value} there. Uses @code{eq?} for equality testing.") + "store @var{val} there. Uses @code{eq?} for equality testing.") #define FUNC_NAME s_scm_hashq_set_x { return scm_hash_fn_set_x (table, key, val, @@ -1010,7 +1010,7 @@ SCM_DEFINE (scm_hashv_ref, "hashv-ref", 2, 1, 0, (SCM table, SCM key, SCM dflt), "Look up @var{key} in the hash table @var{table}, and return the\n" "value (if any) associated with it. If @var{key} is not found,\n" - "return @var{default} (or @code{#f} if no @var{default} argument\n" + "return @var{dflt} (or @code{#f} if no @var{dflt} argument\n" "is supplied). Uses @code{eqv?} for equality testing.") #define FUNC_NAME s_scm_hashv_ref { @@ -1095,7 +1095,7 @@ SCM_DEFINE (scm_hash_ref, "hash-ref", 2, 1, 0, (SCM table, SCM key, SCM dflt), "Look up @var{key} in the hash table @var{table}, and return the\n" "value (if any) associated with it. If @var{key} is not found,\n" - "return @var{default} (or @code{#f} if no @var{default} argument\n" + "return @var{dflt} (or @code{#f} if no @var{dflt} argument\n" "is supplied). Uses @code{equal?} for equality testing.") #define FUNC_NAME s_scm_hash_ref { @@ -1113,7 +1113,7 @@ SCM_DEFINE (scm_hash_ref, "hash-ref", 2, 1, 0, SCM_DEFINE (scm_hash_set_x, "hash-set!", 3, 0, 0, (SCM table, SCM key, SCM val), "Find the entry in @var{table} associated with @var{key}, and\n" - "store @var{value} there. Uses @code{equal?} for equality\n" + "store @var{val} there. Uses @code{equal?} for equality\n" "testing.") #define FUNC_NAME s_scm_hash_set_x { |