summaryrefslogtreecommitdiff
path: root/libguile/guardians.c
diff options
context:
space:
mode:
authorGreg J. Badros <gjb@cs.washington.edu>2000-01-26 01:17:16 +0000
committerGreg J. Badros <gjb@cs.washington.edu>2000-01-26 01:17:16 +0000
commitda4a1dbab4e802a4d516ed6ec456864d22fe5432 (patch)
tree38132b82713e4a12e685b591cc048aaa24ee0aee /libguile/guardians.c
parent7e2cb69cbc7af40c54c0eeb88c2221e715a6a416 (diff)
downloadguile-da4a1dbab4e802a4d516ed6ec456864d22fe5432.tar.gz
* sort.c: typo in comment fixed.
* keywords.c: Added documentation. * guardians.c: Added documentation (could be better). * gc.c: Added docs for gc-set-debug-check-freelist. * eq.c: Added docs for eq?, eqv? equal? abridged from R4RS. * boolean.c: Added docs for `not', `boolean?' (by hand).
Diffstat (limited to 'libguile/guardians.c')
-rw-r--r--libguile/guardians.c11
1 files changed, 10 insertions, 1 deletions
diff --git a/libguile/guardians.c b/libguile/guardians.c
index 403d228c9..7653285ca 100644
--- a/libguile/guardians.c
+++ b/libguile/guardians.c
@@ -151,7 +151,16 @@ static SCM guard1;
SCM_DEFINE (scm_make_guardian, "make-guardian", 0, 0, 0,
(),
-"")
+ "Return a new guardian object.\n"
+ "A guardian allows dynamically allocated objects to be\n"
+ "saved from deallocation by the garbage collector so that\n"
+ "clean up or other actions can be performed using the data\n"
+ "stored within the objects.\n"
+ "See R. Kent Dybvig, Carl Bruggeman, and David Eby (1993)\n"
+ "\"Guardians in a Generation-Based Garbage Collector\".\n"
+ "ACM SIGPLAN Conference on Programming Language Design\n"
+ "and Implementation, June 1993\n"
+ "")
#define FUNC_NAME s_scm_make_guardian
{
SCM cclo = scm_makcclo (guard1, 2L);