diff options
author | Bake Timmons <b3timmons@speedymail.org> | 2012-01-11 12:02:57 -0500 |
---|---|---|
committer | Andy Wingo <wingo@pobox.com> | 2012-02-02 12:04:16 +0100 |
commit | 64de6db5c6a73ffe24fca79cc3be13751f152d28 (patch) | |
tree | e766ff7c5850fca1243b67270601e5611b5017eb /doc/ref/api-smobs.texi | |
parent | 9cbcc73fce39811052519f5f19016b5eb888f151 (diff) |
Make consistent the usage of variable names in the function definitions found in the Texinfo docs.
* doc/r5rs/r5rs.texi:
* doc/ref/api-compound.texi:
* doc/ref/api-data.texi:
* doc/ref/api-debug.texi:
* doc/ref/api-evaluation.texi:
* doc/ref/api-io.texi:
* doc/ref/api-modules.texi:
* doc/ref/api-procedures.texi:
* doc/ref/api-scheduling.texi:
* doc/ref/api-smobs.texi:
* doc/ref/compiler.texi:
* doc/ref/misc-modules.texi:
* doc/ref/posix.texi:
* doc/ref/scheme-using.texi:
* doc/ref/srfi-modules.texi:
* doc/ref/vm.texi:
* doc/ref/web.texi:
* doc/sources/env.texi: Make usage of variable names of function definitions
more consistent.
Diffstat (limited to 'doc/ref/api-smobs.texi')
-rw-r--r-- | doc/ref/api-smobs.texi | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/ref/api-smobs.texi b/doc/ref/api-smobs.texi index db8161cdd..6b042367e 100644 --- a/doc/ref/api-smobs.texi +++ b/doc/ref/api-smobs.texi @@ -22,8 +22,8 @@ If @var{size} is 0, the default @emph{free} function will do nothing. If @var{size} is not 0, the default @emph{free} function will deallocate the memory block pointed to by @code{SCM_SMOB_DATA} with -@code{scm_gc_free}. The @var{WHAT} parameter in the call to -@code{scm_gc_free} will be @var{NAME}. +@code{scm_gc_free}. The @var{what} parameter in the call to +@code{scm_gc_free} will be @var{name}. Default values are provided for the @emph{mark}, @emph{free}, @emph{print}, and @emph{equalp} functions, as described in @@ -43,7 +43,7 @@ a @dfn{finalizer}) for the smob type specified by the tag @var{tc}. @var{tc} is the tag returned by @code{scm_make_smob_type}. The @var{free} procedure must deallocate all resources that are -directly associated with the smob instance @var{OBJ}. It must assume +directly associated with the smob instance @var{obj}. It must assume that all @code{SCM} values that it references have already been freed and are thus invalid. @@ -107,14 +107,14 @@ with @code{scm_display}, @code{scm_write}, @code{scm_simple_format}, and @code{scm_puts}. @end deftypefn -@deftypefn {C Function} void scm_set_smob_equalp (scm_t_bits tc, SCM (*equalp) (SCM obj1, SCM obj1)) +@deftypefn {C Function} void scm_set_smob_equalp (scm_t_bits tc, SCM (*equalp) (SCM obj1, SCM obj2)) This function sets the smob equality-testing predicate for the smob type specified by the tag @var{tc}. @var{tc} is the tag returned by @code{scm_make_smob_type}. The @var{equalp} procedure should return @code{SCM_BOOL_T} when @var{obj1} is @code{equal?} to @var{obj2}. Else it should return -@var{SCM_BOOL_F}. Both @var{obj1} and @var{obj2} are instances of the +@code{SCM_BOOL_F}. Both @var{obj1} and @var{obj2} are instances of the smob type @var{tc}. @end deftypefn |