diff options
| author | Ludovic Courtès <ludo@gnu.org> | 2010-07-28 12:01:54 +0200 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2010-07-28 12:24:25 +0200 |
| commit | 183a2a224b555a29ab311ffcb6abd529a0bdffc1 (patch) | |
| tree | 016210645639ccdad024419446c3fc4accad12fe /libguile/dynl.c | |
| parent | 22697acbc9bae9db44f5f2abcf8d39617d338ad2 (diff) | |
| download | guile-183a2a224b555a29ab311ffcb6abd529a0bdffc1.tar.gz | |
Update the FFI doc.
* doc/ref/api-foreign.texi (Foreign Types): Remove bits about typed
foreign pointers. Add `void'.
(Foreign Variables): Update the doc of `dynamic-pointer' and the
`numptob' example. Remove `foreign-set!' and `foreign-ref'. Add
`pointer-address', `make-pointer', `%null-pointer', and
`null-pointer?'
(Void Pointers and Byte Access): Make it clear that wrapped pointers
are untyped. Remove `void' from here. Replace `foreign->bytevector'
and `bytevector->foreign' by `pointer->bytevector' and
`bytevector->pointer'. Add `dereference-pointer' and the rest of the
`numptob' example.
(Dynamic FFI): Update examples. Remove `%null-pointer' from here.
* libguile/dynl.c (scm_dynamic_pointer): Update docstring.
* libguile/foreign.c (scm_dereference_pointer,
scm_pointer_to_bytevector): Likewise.
* module/system/foreign.scm (null-pointer?): Add docstring.
Diffstat (limited to 'libguile/dynl.c')
| -rw-r--r-- | libguile/dynl.c | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/libguile/dynl.c b/libguile/dynl.c index d26de0325..2b1d656a6 100644 --- a/libguile/dynl.c +++ b/libguile/dynl.c @@ -237,9 +237,9 @@ SCM_DEFINE (scm_dynamic_unlink, "dynamic-unlink", 1, 0, 0, SCM_DEFINE (scm_dynamic_pointer, "dynamic-pointer", 2, 0, 0, (SCM name, SCM dobj), - "Return a ``handle'' for the pointer @var{name} in the\n" - "shared object referred to by @var{dobj}. The handle\n" - "aliases a C object.\n\n" + "Return a ``wrapped pointer'' to the symbol @var{name}\n" + "in the shared object referred to by @var{dobj}. The returned\n" + "pointer points to a C object.\n\n" "This facility works by asking the dynamic linker for\n" "the address of a symbol, then assuming that it aliases a\n" "value of a given type. Obviously, the user must be very\n" |