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/symbols.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/symbols.c')
| -rw-r--r-- | libguile/symbols.c | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/libguile/symbols.c b/libguile/symbols.c index 59aca002e..08512a63f 100644 --- a/libguile/symbols.c +++ b/libguile/symbols.c @@ -384,7 +384,7 @@ SCM_DEFINE (scm_symbol_hash, "symbol-hash", 1, 0, 0, SCM_DEFINE (scm_symbol_fref, "symbol-fref", 1, 0, 0, (SCM s), - "Return the contents of @var{symbol}'s @dfn{function slot}.") + "Return the contents of the symbol @var{s}'s @dfn{function slot}.") #define FUNC_NAME s_scm_symbol_fref { SCM_VALIDATE_SYMBOL (1, s); @@ -395,7 +395,8 @@ SCM_DEFINE (scm_symbol_fref, "symbol-fref", 1, 0, 0, SCM_DEFINE (scm_symbol_pref, "symbol-pref", 1, 0, 0, (SCM s), - "Return the @dfn{property list} currently associated with @var{symbol}.") + "Return the @dfn{property list} currently associated with the\n" + "symbol @var{s}.") #define FUNC_NAME s_scm_symbol_pref { SCM_VALIDATE_SYMBOL (1, s); @@ -406,7 +407,7 @@ SCM_DEFINE (scm_symbol_pref, "symbol-pref", 1, 0, 0, SCM_DEFINE (scm_symbol_fset_x, "symbol-fset!", 2, 0, 0, (SCM s, SCM val), - "Change the binding of @var{symbol}'s function slot.") + "Change the binding of the symbol @var{s}'s function slot.") #define FUNC_NAME s_scm_symbol_fset_x { SCM_VALIDATE_SYMBOL (1, s); @@ -418,7 +419,7 @@ SCM_DEFINE (scm_symbol_fset_x, "symbol-fset!", 2, 0, 0, SCM_DEFINE (scm_symbol_pset_x, "symbol-pset!", 2, 0, 0, (SCM s, SCM val), - "Change the binding of @var{symbol}'s property slot.") + "Change the binding of the symbol @var{s}'s property slot.") #define FUNC_NAME s_scm_symbol_pset_x { SCM_VALIDATE_SYMBOL (1, s); |