mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-16 08:40:19 +02:00
Code Activity

* Docstring fixes - adding texinfo markup and removing extraneous trailing newlines.

Browse source
This commit is contained in:
Neil Jerram 2000-08-18 09:30:54 +00:00
parent 7e6b52f867
commit cdbc74184f
4 changed files with 60 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

12
libguile/ChangeLog
View file

@ -1,3 +1,15 @@
2000-08-18 Neil Jerram <neil@ossau.uklinux.net>
* eq.c (scm_eq_p, scm_eqv_p, scm_equal_p): Add texinfo markup to
docstrings.
* chars.c (scm_char*): Docstring fixes - texinfo markup.
2000-08-18 Neil Jerram <neil@ossau.uklinux.net>
* boolean.c (scm_not, scm_boolean_p): Docstring fixes - add
texinfo markup and remove trailing newlines.
2000-08-17 Michael Livshin <mlivshin@bigfoot.com>
this changes the Guile GC to use cards (aka "chunklets").

4
libguile/boolean.c
View file

@ -54,7 +54,7 @@
SCM_DEFINE (scm_not, "not", 1, 0, 0,
(SCM x),
"Return #t iff X is #f, else return #f.\n")
"Return @code{#t} iff @var{x} is @code{#f}, else return @code{#f}.")
#define FUNC_NAME s_scm_not
{
return SCM_BOOL(SCM_FALSEP(x));
@ -64,7 +64,7 @@ SCM_DEFINE (scm_not, "not", 1, 0, 0,
SCM_DEFINE (scm_boolean_p, "boolean?", 1, 0, 0,
(SCM obj),
"Return #t iff OBJ is either #t or #f.\n")
"Return @code{#t} iff @var{obj} is either @code{#t} or @code{#f}.")
#define FUNC_NAME s_scm_boolean_p
{
return SCM_BOOL (SCM_BOOLP (obj));

52
libguile/chars.c
View file

@ -54,7 +54,7 @@
SCM_DEFINE (scm_char_p, "char?", 1, 0, 0,
(SCM x),
"Return #t iff X is a character, else #f.")
"Return @code{#t} iff @var{x} is a character, else @code{#f}.")
#define FUNC_NAME s_scm_char_p
{
return SCM_BOOL(SCM_CHARP(x));
@ -63,7 +63,7 @@ SCM_DEFINE (scm_char_p, "char?", 1, 0, 0,
SCM_DEFINE1 (scm_char_eq_p, "char=?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X is the same character as Y, else #f.")
"Return @code{#t} iff @var{x} is the same character as @var{y}, else @code{#f}.")
#define FUNC_NAME s_scm_char_eq_p
{
SCM_VALIDATE_CHAR (1,x);
@ -75,7 +75,8 @@ SCM_DEFINE1 (scm_char_eq_p, "char=?", scm_tc7_rpsubr,
SCM_DEFINE1 (scm_char_less_p, "char<?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X is less than Y in the Ascii sequence, else #f.")
"Return @code{#t} iff @var{x} is less than @var{y} in the ASCII sequence,\n"
"else @code{#f}.")
#define FUNC_NAME s_scm_char_less_p
{
SCM_VALIDATE_CHAR (1,x);
@ -86,7 +87,8 @@ SCM_DEFINE1 (scm_char_less_p, "char<?", scm_tc7_rpsubr,
SCM_DEFINE1 (scm_char_leq_p, "char<=?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X is less than or equal to Y in the Ascii sequence, else #f.")
"Return @code{#t} iff @var{x} is less than or equal to @var{y} in the\n"
"ASCII sequence, else @code{#f}.")
#define FUNC_NAME s_scm_char_leq_p
{
SCM_VALIDATE_CHAR (1,x);
@ -97,7 +99,8 @@ SCM_DEFINE1 (scm_char_leq_p, "char<=?", scm_tc7_rpsubr,
SCM_DEFINE1 (scm_char_gr_p, "char>?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X is greater than Y in the Ascii sequence, else #f.")
"Return @code{#t} iff @var{x} is greater than @var{y} in the ASCII\n"
"sequence, else @code{#f}.")
#define FUNC_NAME s_scm_char_gr_p
{
SCM_VALIDATE_CHAR (1,x);
@ -108,7 +111,8 @@ SCM_DEFINE1 (scm_char_gr_p, "char>?", scm_tc7_rpsubr,
SCM_DEFINE1 (scm_char_geq_p, "char>=?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X is greater than or equal to Y in the Ascii sequence, else #f.")
"Return @code{#t} iff @var{x} is greater than or equal to @var{y} in the\n"
"ASCII sequence, else @code{#f}.")
#define FUNC_NAME s_scm_char_geq_p
{
SCM_VALIDATE_CHAR (1,x);
@ -119,7 +123,8 @@ SCM_DEFINE1 (scm_char_geq_p, "char>=?", scm_tc7_rpsubr,
SCM_DEFINE1 (scm_char_ci_eq_p, "char-ci=?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X is the same character as Y ignoring case, else #f.")
"Return @code{#t} iff @var{x} is the same character as @var{y} ignoring\n"
"case, else @code{#f}.")
#define FUNC_NAME s_scm_char_ci_eq_p
{
SCM_VALIDATE_CHAR (1,x);
@ -130,7 +135,8 @@ SCM_DEFINE1 (scm_char_ci_eq_p, "char-ci=?", scm_tc7_rpsubr,
SCM_DEFINE1 (scm_char_ci_less_p, "char-ci<?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X is less than Y in the Ascii sequence ignoring case, else #f.")
"Return @code{#t} iff @var{x} is less than @var{y} in the ASCII sequence\n"
"ignoring case, else @code{#f}.")
#define FUNC_NAME s_scm_char_ci_less_p
{
SCM_VALIDATE_CHAR (1,x);
@ -141,7 +147,8 @@ SCM_DEFINE1 (scm_char_ci_less_p, "char-ci<?", scm_tc7_rpsubr,
SCM_DEFINE1 (scm_char_ci_leq_p, "char-ci<=?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X is less than or equal to Y in the Ascii sequence ignoring case, else #f.")
"Return @code{#t} iff @var{x} is less than or equal to @var{y} in the\n"
"ASCII sequence ignoring case, else @code{#f}.")
#define FUNC_NAME s_scm_char_ci_leq_p
{
SCM_VALIDATE_CHAR (1,x);
@ -152,7 +159,8 @@ SCM_DEFINE1 (scm_char_ci_leq_p, "char-ci<=?", scm_tc7_rpsubr,
SCM_DEFINE1 (scm_char_ci_gr_p, "char-ci>?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X is greater than Y in the Ascii sequence ignoring case, else #f.")
"Return @code{#t} iff @var{x} is greater than @var{y} in the ASCII\n"
"sequence ignoring case, else @code{#f}.")
#define FUNC_NAME s_scm_char_ci_gr_p
{
SCM_VALIDATE_CHAR (1,x);
@ -163,7 +171,8 @@ SCM_DEFINE1 (scm_char_ci_gr_p, "char-ci>?", scm_tc7_rpsubr,
SCM_DEFINE1 (scm_char_ci_geq_p, "char-ci>=?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X is greater than or equal to Y in the Ascii sequence ignoring case, else #f.")
"Return @code{#t} iff @var{x} is greater than or equal to @var{y} in the\n"
"ASCII sequence ignoring case, else @code{#f}.")
#define FUNC_NAME s_scm_char_ci_geq_p
{
SCM_VALIDATE_CHAR (1,x);
@ -175,7 +184,7 @@ SCM_DEFINE1 (scm_char_ci_geq_p, "char-ci>=?", scm_tc7_rpsubr,
SCM_DEFINE (scm_char_alphabetic_p, "char-alphabetic?", 1, 0, 0,
(SCM chr),
"Return #t iff CHR is alphabetic, else #f.\n"
"Return @code{#t} iff @var{chr} is alphabetic, else @code{#f}.\n"
"Alphabetic means the same thing as the isalpha C library function.")
#define FUNC_NAME s_scm_char_alphabetic_p
{
@ -186,7 +195,7 @@ SCM_DEFINE (scm_char_alphabetic_p, "char-alphabetic?", 1, 0, 0,
SCM_DEFINE (scm_char_numeric_p, "char-numeric?", 1, 0, 0,
(SCM chr),
"Return #t iff CHR is numeric, else #f.\n"
"Return @code{#t} iff @var{chr} is numeric, else @code{#f}.\n"
"Numeric means the same thing as the isdigit C library function.")
#define FUNC_NAME s_scm_char_numeric_p
{
@ -197,7 +206,7 @@ SCM_DEFINE (scm_char_numeric_p, "char-numeric?", 1, 0, 0,
SCM_DEFINE (scm_char_whitespace_p, "char-whitespace?", 1, 0, 0,
(SCM chr),
"Return #t iff CHR is whitespace, else #f.\n"
"Return @code{#t} iff @var{chr} is whitespace, else @code{#f}.\n"
"Whitespace means the same thing as the isspace C library function.")
#define FUNC_NAME s_scm_char_whitespace_p
{
@ -210,7 +219,7 @@ SCM_DEFINE (scm_char_whitespace_p, "char-whitespace?", 1, 0, 0,
SCM_DEFINE (scm_char_upper_case_p, "char-upper-case?", 1, 0, 0,
(SCM chr),
"Return #t iff CHR is uppercase, else #f.\n"
"Return @code{#t} iff @var{chr} is uppercase, else @code{#f}.\n"
"Uppercase means the same thing as the isupper C library function.")
#define FUNC_NAME s_scm_char_upper_case_p
{
@ -222,7 +231,7 @@ SCM_DEFINE (scm_char_upper_case_p, "char-upper-case?", 1, 0, 0,
SCM_DEFINE (scm_char_lower_case_p, "char-lower-case?", 1, 0, 0,
(SCM chr),
"Return #t iff CHR is lowercase, else #f.\n"
"Return @code{#t} iff @var{chr} is lowercase, else @code{#f}.\n"
"Lowercase means the same thing as the islower C library function.")
#define FUNC_NAME s_scm_char_lower_case_p
{
@ -235,7 +244,7 @@ SCM_DEFINE (scm_char_lower_case_p, "char-lower-case?", 1, 0, 0,
SCM_DEFINE (scm_char_is_both_p, "char-is-both?", 1, 0, 0,
(SCM chr),
"Return #t iff CHR is either uppercase or lowercase, else #f.\n"
"Return @code{#t} iff @var{chr} is either uppercase or lowercase, else @code{#f}.\n"
"Uppercase and lowercase are as defined by the isupper and islower\n"
"C library functions.")
#define FUNC_NAME s_scm_char_is_both_p
@ -250,7 +259,8 @@ SCM_DEFINE (scm_char_is_both_p, "char-is-both?", 1, 0, 0,
SCM_DEFINE (scm_char_to_integer, "char->integer", 1, 0, 0,
(SCM chr),
"Return the number corresponding to ordinal position of CHR in the Ascii sequence.")
"Return the number corresponding to ordinal position of @var{chr} in the\n"
"ASCII sequence.")
#define FUNC_NAME s_scm_char_to_integer
{
SCM_VALIDATE_CHAR (1,chr);
@ -262,7 +272,7 @@ SCM_DEFINE (scm_char_to_integer, "char->integer", 1, 0, 0,
SCM_DEFINE (scm_integer_to_char, "integer->char", 1, 0, 0,
(SCM n),
"Return the character at position N in the Ascii sequence.")
"Return the character at position @var{n} in the ASCII sequence.")
#define FUNC_NAME s_scm_integer_to_char
{
SCM_VALIDATE_INUM_RANGE (1, n, 0, 256);
@ -273,7 +283,7 @@ SCM_DEFINE (scm_integer_to_char, "integer->char", 1, 0, 0,
SCM_DEFINE (scm_char_upcase, "char-upcase", 1, 0, 0,
(SCM chr),
"Return the uppercase character version of CHR.")
"Return the uppercase character version of @var{chr}.")
#define FUNC_NAME s_scm_char_upcase
{
SCM_VALIDATE_CHAR (1,chr);
@ -284,7 +294,7 @@ SCM_DEFINE (scm_char_upcase, "char-upcase", 1, 0, 0,
SCM_DEFINE (scm_char_downcase, "char-downcase", 1, 0, 0,
(SCM chr),
"Return the lowercase character version of CHR.")
"Return the lowercase character version of @var{chr}.")
#define FUNC_NAME s_scm_char_downcase
{
SCM_VALIDATE_CHAR (1,chr);

30
libguile/eq.c
View file

@ -59,10 +59,10 @@
SCM_DEFINE1 (scm_eq_p, "eq?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X references the same object as Y.\n"
"`eq?' is similar to `eqv?' except that in some cases\n"
"it is capable of discerning distinctions finer than\n"
"those detectable by `eqv?'.\n")
"Return @code{#t} iff @var{x} references the same object as @var{y}.\n"
"@code{eq?} is similar to @code{eqv?} except that in some cases it is\n"
"capable of discerning distinctions finer than those detectable by\n"
"@code{eqv?}.")
#define FUNC_NAME s_scm_eq_p
{
return SCM_BOOL (SCM_EQ_P (x, y));
@ -72,11 +72,11 @@ SCM_DEFINE1 (scm_eq_p, "eq?", scm_tc7_rpsubr,
SCM_DEFINE1 (scm_eqv_p, "eqv?", scm_tc7_rpsubr,
(SCM x, SCM y),
"The `eqv?' procedure defines a useful equivalence relation on objects.\n"
"Briefly, it returns #t if X and Y should normally be\n"
"regarded as the same object. This relation is left\n"
"slightly open to interpretation, but works for comparing\n"
"immediate integers, characters, and inexact numbers.\n")
"The @code{eqv?} procedure defines a useful equivalence relation on objects.\n"
"Briefly, it returns @code{#t} if @var{x} and @var{y} should normally be\n"
"regarded as the same object. This relation is left slightly open to\n"
"interpretation, but works for comparing immediate integers, characters,\n"
"and inexact numbers.")
#define FUNC_NAME s_scm_eqv_p
{
if (SCM_EQ_P (x, y))
@ -120,12 +120,12 @@ SCM_DEFINE1 (scm_eqv_p, "eqv?", scm_tc7_rpsubr,
SCM_DEFINE1 (scm_equal_p, "equal?", scm_tc7_rpsubr,
(SCM x, SCM y),
"Return #t iff X and Y are recursively `eqv?' equivalent.\n"
"`equal?' recursively compares the contents of pairs, vectors, and\n"
"strings, applying `eqv?' on other objects such as numbers and\n"
"symbols. A rule of thumb is that objects are generally `equal?'\n"
"if they print the same. `Equal?' may fail to terminate if its\n"
"arguments are circular data structures.\n")
"Return @code{#t} iff @var{x} and @var{y} are recursively @code{eqv?} equivalent.\n"
"@code{equal?} recursively compares the contents of pairs,\n"
"vectors, and strings, applying @code{eqv?} on other objects such as\n"
"numbers and symbols. A rule of thumb is that objects are generally\n"
"@code{equal?} if they print the same. @code{equal?} may fail to\n"
"terminate if its arguments are circular data structures.")
#define FUNC_NAME s_scm_equal_p
{
SCM_CHECK_STACK;