summaryrefslogtreecommitdiff
path: root/doc/ref/api-foreign-objects.texi
diff options
context:
space:
mode:
authorAndy Wingo <wingo@pobox.com>2014-04-28 17:45:07 +0200
committerAndy Wingo <wingo@pobox.com>2014-04-28 17:45:07 +0200
commitd9a4a1cde13422a8e9656bb7745dc31692deb955 (patch)
tree5b23dc5b58ace811e12b993bab7a458f3836dfb6 /doc/ref/api-foreign-objects.texi
parent6e4630e01a7192451e2d1806b26ebf38816464e4 (diff)
downloadguile-d9a4a1cde13422a8e9656bb7745dc31692deb955.tar.gz
Remove SMOB tutorial; update manual.
* doc/ref/libguile-smobs.texi: Remove; this tutorial is superseded by libguile-foreign-objects. * doc/ref/libguile-foreign-objects.texi: Proofreading. * doc/ref/libguile-program.texi: Update Dia examples to refer to foreign objects. * doc/ref/libguile-concepts.texi (Garbage Collection): Update to accurately describe the BDW-GC, and to avoid reference to mark functions. * doc/ref/guile.texi: Remove libguile-smobs, and reword API menu. * doc/ref/api-utility.texi (Equality): Mention GOOPS instead of SMOBs. * doc/ref/api-smobs.texi (Smobs): Describe as a legacy interface. Exhort readers against the writing of mark functions. * doc/ref/api-foreign-objects.texi (Foreign Objects): Proofreading. * doc/ref/api-control.texi (Catch): Fix ref to point to foreign objects. * doc/ref/Makefile.am: Remove libguile-smobs.texi.
Diffstat (limited to 'doc/ref/api-foreign-objects.texi')
-rw-r--r--doc/ref/api-foreign-objects.texi9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/ref/api-foreign-objects.texi b/doc/ref/api-foreign-objects.texi
index eb7a462e1..f27f9c154 100644
--- a/doc/ref/api-foreign-objects.texi
+++ b/doc/ref/api-foreign-objects.texi
@@ -14,7 +14,8 @@ working with foreign objects. @xref{Defining New Foreign Object Types},
for a tutorial-like introduction to foreign objects.
@deftp {C Type} scm_t_struct_finalize
-This type returns @code{void} and takes one @code{SCM} argument.
+This function type returns @code{void} and takes one @code{SCM}
+argument.
@end deftp
@deftypefn {C Function} SCM scm_make_foreign_object_type (SCM name, SCM slots, scm_t_struct_finalize finalizer)
@@ -73,9 +74,9 @@ initialize the first @var{n} fields to the given values, as appropriate.
The number of fields for objects of a given type is fixed when the type
is created. It is an error to give more initializers than there are
fields in the value. It is perfectly fine to give fewer initializers
-than needed, however; this is convenient when some fields are of
-non-pointer types, and it would be easier to initialize them with the
-setters indicated below.
+than needed; this is convenient when some fields are of non-pointer
+types, and would be easier to initialize with the setters described
+below.
@end deftypefn
@deftypefn {C Function} void* scm_foreign_object_ref (SCM obj, size_t n);