1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-04-30 03:40:34 +02:00

* Documentation work.

This commit is contained in:
Neil Jerram 2001-11-11 15:01:52 +00:00
parent a0a9b9ad42
commit 9401323e63
42 changed files with 3992 additions and 3319 deletions

View file

@ -78,7 +78,7 @@ make_variable (SCM init)
SCM_DEFINE (scm_make_variable, "make-variable", 1, 0, 0,
(SCM init),
"Return a variable initialized to value @var{init}.\n")
"Return a variable initialized to value @var{init}.")
#define FUNC_NAME s_scm_make_variable
{
return make_variable (init);
@ -88,7 +88,7 @@ SCM_DEFINE (scm_make_variable, "make-variable", 1, 0, 0,
SCM_DEFINE (scm_make_undefined_variable, "make-undefined-variable", 0, 0, 0,
(),
"Return a variable that is initially unbound.\n")
"Return a variable that is initially unbound.")
#define FUNC_NAME s_scm_make_undefined_variable
{
return make_variable (SCM_UNDEFINED);
@ -99,7 +99,7 @@ SCM_DEFINE (scm_make_undefined_variable, "make-undefined-variable", 0, 0, 0,
SCM_DEFINE (scm_variable_p, "variable?", 1, 0, 0,
(SCM obj),
"Return @code{#t} iff @var{obj} is a variable object, else\n"
"return @code{#f}\n")
"return @code{#f}.")
#define FUNC_NAME s_scm_variable_p
{
return SCM_BOOL (SCM_VARIABLEP (obj));
@ -127,7 +127,7 @@ SCM_DEFINE (scm_variable_set_x, "variable-set!", 2, 0, 0,
(SCM var, SCM val),
"Set the value of the variable @var{var} to @var{val}.\n"
"@var{var} must be a variable object, @var{val} can be any\n"
"value. Return an unspecified value.\n")
"value. Return an unspecified value.")
#define FUNC_NAME s_scm_variable_set_x
{
SCM_VALIDATE_VARIABLE (1, var);
@ -139,7 +139,7 @@ SCM_DEFINE (scm_variable_set_x, "variable-set!", 2, 0, 0,
SCM_DEFINE (scm_variable_bound_p, "variable-bound?", 1, 0, 0,
(SCM var),
"Return @code{#t} iff @var{var} is bound to a value.\n"
"Throws an error if @var{var} is not a variable object.\n")
"Throws an error if @var{var} is not a variable object.")
#define FUNC_NAME s_scm_variable_bound_p
{
SCM_VALIDATE_VARIABLE (1, var);