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/threads.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/threads.c')
-rw-r--r-- | libguile/threads.c | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/libguile/threads.c b/libguile/threads.c index 5a13e5ccf..7944f4868 100644 --- a/libguile/threads.c +++ b/libguile/threads.c @@ -1475,11 +1475,12 @@ SCM scm_lock_mutex (SCM mx) SCM_DEFINE (scm_lock_mutex_timed, "lock-mutex", 1, 2, 0, (SCM m, SCM timeout, SCM owner), -"Lock @var{mutex}. If the mutex is already locked, the calling thread " -"blocks until the mutex becomes available. The function returns when " -"the calling thread owns the lock on @var{mutex}. Locking a mutex that " -"a thread already owns will succeed right away and will not block the " -"thread. That is, Guile's mutexes are @emph{recursive}. ") + "Lock mutex @var{m}. If the mutex is already locked, the calling\n" + "thread blocks until the mutex becomes available. The function\n" + "returns when the calling thread owns the lock on @var{m}.\n" + "Locking a mutex that a thread already owns will succeed right\n" + "away and will not block the thread. That is, Guile's mutexes\n" + "are @emph{recursive}.") #define FUNC_NAME s_scm_lock_mutex_timed { SCM exception; @@ -1769,9 +1770,9 @@ SCM_DEFINE (scm_make_condition_variable, "make-condition-variable", 0, 0, 0, SCM_DEFINE (scm_timed_wait_condition_variable, "wait-condition-variable", 2, 1, 0, (SCM cv, SCM mx, SCM t), -"Wait until @var{cond-var} has been signalled. While waiting, " -"@var{mutex} is atomically unlocked (as with @code{unlock-mutex}) and " -"is locked again when this function returns. When @var{time} is given, " +"Wait until condition variable @var{cv} has been signalled. While waiting, " +"mutex @var{mx} is atomically unlocked (as with @code{unlock-mutex}) and " +"is locked again when this function returns. When @var{t} is given, " "it specifies a point in time where the waiting should be aborted. It " "can be either a integer as returned by @code{current-time} or a pair " "as returned by @code{gettimeofday}. When the waiting is aborted the " |