diff options
author | Greg J. Badros <gjb@cs.washington.edu> | 2000-02-07 04:30:17 +0000 |
---|---|---|
committer | Greg J. Badros <gjb@cs.washington.edu> | 2000-02-07 04:30:17 +0000 |
commit | d7588e548107ad9396a3e16a53aa3c91d8f7bbfe (patch) | |
tree | d230392aec9f19342aa1385e7679a12bffb8b750 | |
parent | bd9e24b30126cb31005ca286118609eb6f4dfbba (diff) | |
download | guile-d7588e548107ad9396a3e16a53aa3c91d8f7bbfe.tar.gz |
* pairs.c: Doc patches from Richard Kim. Pasted from MIT Scheme
(which is GNU GPL'd).
-rw-r--r-- | libguile/pairs.c | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/libguile/pairs.c b/libguile/pairs.c index 21415b3b6..742a95ebf 100644 --- a/libguile/pairs.c +++ b/libguile/pairs.c @@ -56,7 +56,9 @@ SCM_DEFINE (scm_cons, "cons", 2, 0, 0, (SCM x, SCM y), -"") + "Returns a newly allocated pair whose car is @var{x} and whose cdr is\n" + "@var{y}. The pair is guaranteed to be different (in the sense of\n" + "@code{eqv?}) from every previously existing object.") #define FUNC_NAME s_scm_cons { register SCM z; @@ -85,7 +87,7 @@ scm_cons2 (SCM w, SCM x, SCM y) SCM_DEFINE (scm_pair_p, "pair?", 1, 0, 0, (SCM x), -"") + "Returns @code{#t} if @var{x} is a pair; otherwise returns @code{#f}.") #define FUNC_NAME s_scm_pair_p { if (SCM_IMP (x)) @@ -96,7 +98,8 @@ SCM_DEFINE (scm_pair_p, "pair?", 1, 0, 0, SCM_DEFINE (scm_set_car_x, "set-car!", 2, 0, 0, (SCM pair, SCM value), -"") + "Stores @var{value} in the car field of @var{pair}. The value returned\n" + "by @code{set-car!} is unspecified.") #define FUNC_NAME s_scm_set_car_x { SCM_VALIDATE_CONS (1,pair); @@ -107,7 +110,8 @@ SCM_DEFINE (scm_set_car_x, "set-car!", 2, 0, 0, SCM_DEFINE (scm_set_cdr_x, "set-cdr!", 2, 0, 0, (SCM pair, SCM value), -"") + "Stores @var{value} in the cdr field of @var{pair}. The value returned\n" + "by @code{set-cdr!} is unspecified.") #define FUNC_NAME s_scm_set_cdr_x { SCM_VALIDATE_CONS (1,pair); |