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

* list.c (scm_list, scm_cons_star, scm_null_p, scm_list_p),

(scm_length, scm_append, scm_reverse, scm_list_ref),
	(scm_memq, scm_memv, scm_member, scm_delv_x, scm_delete_x),
	(scm_delq, scm_delv, scm_delete, scm_delq1_x, scm_delv1_x),
	(scm_delete1_x), gc.c (scm_map_free_list),
	(scm_free_list_length), hash.c (scm_hashq, scm_hashv),
	(scm_hash), hashtab.c (scm_hashq_ref, scm_hashq_set_x),
	(scm_hashq_remove_x, scm_hashv_ref, scm_hashv_set_x),
	(scm_hashv_remove_x, scm_hash_ref, scm_hash_set_x),
	(scm_hash_remove_x), ports.c (scm_pt_size, scm_pt_member), print.c
	(scm_current_pstate), scmsigs.c (scm_usleep), goops.c
	(scm_get_keyword, scm_sys_compute_slots): Added texinfo markup.

	* weaks.c (scm_weak_vector_p, scm_weak_key_hash_table_p),
	(scm_weak_value_hash_table_p, scm_doubly_weak_hash_table_p),
	rdelim.c (scm_read_delimited_x), strop.c (scm_string_index),
	symbols.c (scm_symbol_interned_p), numbers.c
	(scm_string_to_number), ports.c (scm_port_p): Corrected texinfo
	markup.
This commit is contained in:
Martin Grabmüller 2001-03-16 10:00:17 +00:00
parent 1543613f4b
commit 5352393c55
14 changed files with 210 additions and 163 deletions

View file

@ -1,3 +1,25 @@
2001-03-16 Martin Grabmueller <mgrabmue@cs.tu-berlin.de>
* list.c (scm_list, scm_cons_star, scm_null_p, scm_list_p),
(scm_length, scm_append, scm_reverse, scm_list_ref),
(scm_memq, scm_memv, scm_member, scm_delv_x, scm_delete_x),
(scm_delq, scm_delv, scm_delete, scm_delq1_x, scm_delv1_x),
(scm_delete1_x), gc.c (scm_map_free_list),
(scm_free_list_length), hash.c (scm_hashq, scm_hashv),
(scm_hash), hashtab.c (scm_hashq_ref, scm_hashq_set_x),
(scm_hashq_remove_x, scm_hashv_ref, scm_hashv_set_x),
(scm_hashv_remove_x, scm_hash_ref, scm_hash_set_x),
(scm_hash_remove_x), ports.c (scm_pt_size, scm_pt_member), print.c
(scm_current_pstate), scmsigs.c (scm_usleep), goops.c
(scm_get_keyword, scm_sys_compute_slots): Added texinfo markup.
* weaks.c (scm_weak_vector_p, scm_weak_key_hash_table_p),
(scm_weak_value_hash_table_p, scm_doubly_weak_hash_table_p),
rdelim.c (scm_read_delimited_x), strop.c (scm_string_index),
symbols.c (scm_symbol_interned_p), numbers.c
(scm_string_to_number), ports.c (scm_port_p): Corrected texinfo
markup.
2001-03-16 Keisuke Nishida <kxn30@po.cwru.edu>
* snarf.h (SCM_CONST_LONG): Deprecated.

View file

@ -515,8 +515,9 @@ map_free_list (scm_freelist_t *master, SCM freelist)
SCM_DEFINE (scm_map_free_list, "map-free-list", 0, 0, 0,
(),
"Print debugging information about the free-list.\n"
"`map-free-list' is only included in --enable-guile-debug builds of Guile.")
"Print debugging information about the free-list.\n"
"@code{map-free-list} is only included in\n"
"@code{--enable-guile-debug} builds of Guile.")
#define FUNC_NAME s_scm_map_free_list
{
int i;
@ -595,8 +596,9 @@ free_list_lengths (char *title, scm_freelist_t *master, SCM freelist)
SCM_DEFINE (scm_free_list_length, "free-list-length", 0, 0, 0,
(),
"Print debugging information about the free-list.\n"
"`free-list-length' is only included in --enable-guile-debug builds of Guile.")
"Print debugging information about the free-list.\n"
"@code{free-list-length} is only included in\n"
"@code{--enable-guile-debug} builds of Guile.")
#define FUNC_NAME s_scm_free_list_length
{
free_list_lengths ("1-cells", &scm_master_freelist, scm_freelist);

View file

@ -285,9 +285,9 @@ maplist (SCM ls)
SCM_DEFINE (scm_sys_compute_slots, "%compute-slots", 1, 0, 0,
(SCM class),
"Return a list consisting of the names of all slots belonging\n"
"to class CLASS, i. e. the slots of CLASS and of all of its\n"
"superclasses.")
"Return a list consisting of the names of all slots belonging to\n"
"class @var{class}, i. e. the slots of @var{class} and of all of\n"
"its superclasses.")
#define FUNC_NAME s_scm_sys_compute_slots
{
SCM_VALIDATE_CLASS (1, class);
@ -367,11 +367,12 @@ scm_i_get_keyword (SCM key, SCM l, int len, SCM default_value, const char *subr)
SCM_DEFINE (scm_get_keyword, "get-keyword", 3, 0, 0,
(SCM key, SCM l, SCM default_value),
"Determine an associated value for the keyword KEY from the\n"
"list L. The list L has to consist of an even number of\n"
"elements, where, starting with the first, every second element\n"
"is a keyword, followed by its associated value. If L does not\n"
"hold a value for KEY, the value DEFAULT_VALUE is returned.")
"Determine an associated value for the keyword @var{key} from\n"
"the list @var{l}. The list @var{l} has to consist of an even\n"
"number of elements, where, starting with the first, every\n"
"second element is a keyword, followed by its associated value.\n"
"If @var{l} does not hold a value for @var{key}, the value\n"
"@var{default_value} is returned.")
#define FUNC_NAME s_scm_get_keyword
{
int len;

View file

@ -190,15 +190,16 @@ scm_ihashq (SCM obj, unsigned int n)
SCM_DEFINE (scm_hashq, "hashq", 2, 0, 0,
(SCM key, SCM size),
"Determine a hash value for KEY that is suitable for lookups in\n"
"a hashtable of size SIZE, where eq? is used as the equality\n"
"predicate. The function returns an integer in the range 0 to\n"
"SIZE - 1. NOTE that `hashq' may use internal addresses.\n"
"Thus two calls to hashq where the keys are eq? are not\n"
"guaranteed to deliver the same value if the key object gets\n"
"garbage collected in between. This can happen, for example\n"
"with symbols: (hashq 'foo n) (gc) (hashq 'foo n) may produce two\n"
"different values, since 'foo will be garbage collected.")
"Determine a hash value for @var{key} that is suitable for\n"
"lookups in a hashtable of size @var{size}, where @code{eq?} is\n"
"used as the equality predicate. The function returns an\n"
"integer in the range 0 to @var{size} - 1. Note that\n"
"@code{hashq} may use internal addresses. Thus two calls to\n"
"hashq where the keys are @code{eq?} are not guaranteed to\n"
"deliver the same value if the key object gets garbage collected\n"
"in between. This can happen, for example with symbols:\n"
"@code{(hashq 'foo n) (gc) (hashq 'foo n)} may produce two\n"
"different values, since @code{foo} will be garbage collected.")
#define FUNC_NAME s_scm_hashq
{
SCM_VALIDATE_INUM_MIN (2, size, 0);
@ -225,15 +226,16 @@ scm_ihashv (SCM obj, unsigned int n)
SCM_DEFINE (scm_hashv, "hashv", 2, 0, 0,
(SCM key, SCM size),
"Determine a hash value for KEY that is suitable for lookups in\n"
"a hashtable of size SIZE, where eqv? is used as the equality\n"
"predicate. The function returns an integer in the range 0 to\n"
"SIZE - 1. NOTE that (hashv key) may use internal addresses.\n"
"Thus two calls to hashv where the keys are eqv? are not\n"
"guaranteed to deliver the same value if the key object gets\n"
"garbage collected in between. This can happen, for example\n"
"with symbols: (hashv 'foo n) (gc) (hashv 'foo n) may produce two\n"
"different values, since 'foo will be garbage collected.")
"Determine a hash value for @var{key} that is suitable for\n"
"lookups in a hashtable of size @var{size}, where @code{eqv?} is\n"
"used as the equality predicate. The function returns an\n"
"integer in the range 0 to @var{size} - 1. Note that\n"
"@code{(hashv key)} may use internal addresses. Thus two calls\n"
"to hashv where the keys are @code{eqv?} are not guaranteed to\n"
"deliver the same value if the key object gets garbage collected\n"
"in between. This can happen, for example with symbols:\n"
"@code{(hashv 'foo n) (gc) (hashv 'foo n)} may produce two\n"
"different values, since @code{foo} will be garbage collected.")
#define FUNC_NAME s_scm_hashv
{
SCM_VALIDATE_INUM_MIN (2, size, 0);
@ -253,10 +255,10 @@ scm_ihash (SCM obj, unsigned int n)
SCM_DEFINE (scm_hash, "hash", 2, 0, 0,
(SCM key, SCM size),
"Determine a hash value for KEY that is suitable for lookups in\n"
"a hashtable of size SIZE, where equal? is used as the equality\n"
"predicate. The function returns an integer in the range 0 to\n"
"SIZE - 1.")
"Determine a hash value for @var{key} that is suitable for\n"
"lookups in a hashtable of size @var{size}, where @code{equal?}\n"
"is used as the equality predicate. The function returns an\n"
"integer in the range 0 to @var{size} - 1.")
#define FUNC_NAME s_scm_hash
{
SCM_VALIDATE_INUM_MIN (2, size, 0);

View file

@ -195,8 +195,8 @@ SCM_DEFINE (scm_hashq_ref, "hashq-ref", 2, 1, 0,
(SCM table, SCM obj, SCM dflt),
"Look up @var{key} in the hash table @var{table}, and return the\n"
"value (if any) associated with it. If @var{key} is not found,\n"
"return @var{default} (or @code{#f} if no @var{default} argument is\n"
"supplied). Uses `eq?' for equality testing.")
"return @var{default} (or @code{#f} if no @var{default} argument\n"
"is supplied). Uses @code{eq?} for equality testing.")
#define FUNC_NAME s_scm_hashq_ref
{
if (SCM_UNBNDP (dflt))
@ -209,8 +209,8 @@ SCM_DEFINE (scm_hashq_ref, "hashq-ref", 2, 1, 0,
SCM_DEFINE (scm_hashq_set_x, "hashq-set!", 3, 0, 0,
(SCM table, SCM obj, SCM val),
"Find the entry in @var{table} associated with @var{key}, and store\n"
"@var{value} there. Uses `eq?' for equality testing.")
"Find the entry in @var{table} associated with @var{key}, and\n"
"store @var{value} there. Uses @code{eq?} for equality testing.")
#define FUNC_NAME s_scm_hashq_set_x
{
return scm_hash_fn_set_x (table, obj, val, scm_ihashq, scm_sloppy_assq, 0);
@ -221,8 +221,8 @@ SCM_DEFINE (scm_hashq_set_x, "hashq-set!", 3, 0, 0,
SCM_DEFINE (scm_hashq_remove_x, "hashq-remove!", 2, 0, 0,
(SCM table, SCM obj),
"Remove @var{key} (and any value associated with it) from @var{table}.\n"
"Uses `eq?' for equality tests.")
"Remove @var{key} (and any value associated with it) from\n"
"@var{table}. Uses @code{eq?} for equality tests.")
#define FUNC_NAME s_scm_hashq_remove_x
{
return scm_hash_fn_remove_x (table, obj, scm_ihashq, scm_sloppy_assq, scm_delq_x, 0);
@ -263,8 +263,8 @@ SCM_DEFINE (scm_hashv_ref, "hashv-ref", 2, 1, 0,
(SCM table, SCM obj, SCM dflt),
"Look up @var{key} in the hash table @var{table}, and return the\n"
"value (if any) associated with it. If @var{key} is not found,\n"
"return @var{default} (or @code{#f} if no @var{default} argument is\n"
"supplied). Uses `eqv?' for equality testing.")
"return @var{default} (or @code{#f} if no @var{default} argument\n"
"is supplied). Uses @code{eqv?} for equality testing.")
#define FUNC_NAME s_scm_hashv_ref
{
if (SCM_UNBNDP (dflt))
@ -277,8 +277,8 @@ SCM_DEFINE (scm_hashv_ref, "hashv-ref", 2, 1, 0,
SCM_DEFINE (scm_hashv_set_x, "hashv-set!", 3, 0, 0,
(SCM table, SCM obj, SCM val),
"Find the entry in @var{table} associated with @var{key}, and store\n"
"@var{value} there. Uses `eqv?' for equality testing.")
"Find the entry in @var{table} associated with @var{key}, and\n"
"store @var{value} there. Uses @code{eqv?} for equality testing.")
#define FUNC_NAME s_scm_hashv_set_x
{
return scm_hash_fn_set_x (table, obj, val, scm_ihashv, scm_sloppy_assv, 0);
@ -288,8 +288,8 @@ SCM_DEFINE (scm_hashv_set_x, "hashv-set!", 3, 0, 0,
SCM_DEFINE (scm_hashv_remove_x, "hashv-remove!", 2, 0, 0,
(SCM table, SCM obj),
"Remove @var{key} (and any value associated with it) from @var{table}.\n"
"Uses `eqv?' for equality tests.")
"Remove @var{key} (and any value associated with it) from\n"
"@var{table}. Uses @code{eqv?} for equality tests.")
#define FUNC_NAME s_scm_hashv_remove_x
{
return scm_hash_fn_remove_x (table, obj, scm_ihashv, scm_sloppy_assv, scm_delv_x, 0);
@ -329,8 +329,8 @@ SCM_DEFINE (scm_hash_ref, "hash-ref", 2, 1, 0,
(SCM table, SCM obj, SCM dflt),
"Look up @var{key} in the hash table @var{table}, and return the\n"
"value (if any) associated with it. If @var{key} is not found,\n"
"return @var{default} (or @code{#f} if no @var{default} argument is\n"
"supplied). Uses `equal?' for equality testing.")
"return @var{default} (or @code{#f} if no @var{default} argument\n"
"is supplied). Uses @code{equal?} for equality testing.")
#define FUNC_NAME s_scm_hash_ref
{
if (SCM_UNBNDP (dflt))
@ -343,8 +343,9 @@ SCM_DEFINE (scm_hash_ref, "hash-ref", 2, 1, 0,
SCM_DEFINE (scm_hash_set_x, "hash-set!", 3, 0, 0,
(SCM table, SCM obj, SCM val),
"Find the entry in @var{table} associated with @var{key}, and store\n"
"@var{value} there. Uses `equal?' for equality testing.")
"Find the entry in @var{table} associated with @var{key}, and\n"
"store @var{value} there. Uses @code{equal?} for equality\n"
"testing.")
#define FUNC_NAME s_scm_hash_set_x
{
return scm_hash_fn_set_x (table, obj, val, scm_ihash, scm_sloppy_assoc, 0);
@ -355,8 +356,8 @@ SCM_DEFINE (scm_hash_set_x, "hash-set!", 3, 0, 0,
SCM_DEFINE (scm_hash_remove_x, "hash-remove!", 2, 0, 0,
(SCM table, SCM obj),
"Remove @var{key} (and any value associated with it) from @var{table}.\n"
"Uses `equal?' for equality tests.")
"Remove @var{key} (and any value associated with it) from\n"
"@var{table}. Uses @code{equal?} for equality tests.")
#define FUNC_NAME s_scm_hash_remove_x
{
return scm_hash_fn_remove_x (table, obj, scm_ihash, scm_sloppy_assoc, scm_delete_x, 0);

View file

@ -80,7 +80,8 @@ scm_listify (SCM elt, ...)
SCM_DEFINE (scm_list, "list", 0, 0, 1,
(SCM objs),
"Return a list containing OBJS, the arguments to `list'.")
"Return a list containing @var{objs}, the arguments to\n"
"@code{list}.")
#define FUNC_NAME s_scm_list
{
return objs;
@ -96,11 +97,12 @@ SCM_REGISTER_PROC (s_list_star, "list*", 1, 0, 1, scm_cons_star);
SCM_DEFINE (scm_cons_star, "cons*", 1, 0, 1,
(SCM arg, SCM rest),
"Like `list', but the last arg provides the tail of the constructed list,\n"
"returning (cons ARG1 (cons ARG2 (cons ... ARGn))).\n"
"Requires at least one argument. If given one argument, that argument\n"
"is returned as result.\n"
"This function is called `list*' in some other Schemes and in Common LISP.")
"Like @code{list}, but the last arg provides the tail of the\n"
"constructed list, returning @code{(cons @var{arg1} (cons\n"
"@var{arg2} (cons @dots{} @var{argn}))). Requires at least one\n"
"argument. If given one argument, that argument is returned as\n"
"result. This function is called @code{list*} in some other\n"
"Schemes and in Common LISP.")
#define FUNC_NAME s_scm_cons_star
{
SCM_VALIDATE_REST_ARGUMENT (rest);
@ -124,7 +126,7 @@ SCM_DEFINE (scm_cons_star, "cons*", 1, 0, 1,
SCM_DEFINE (scm_null_p, "null?", 1, 0, 0,
(SCM x),
"Return #t iff X is the empty list, else #f.")
"Return @code{#t} iff @var{x} is the empty list, else @code{#f}.")
#define FUNC_NAME s_scm_null_p
{
return SCM_BOOL (SCM_NULLP (x));
@ -134,7 +136,7 @@ SCM_DEFINE (scm_null_p, "null?", 1, 0, 0,
SCM_DEFINE (scm_list_p, "list?", 1, 0, 0,
(SCM x),
"Return #t iff X is a proper list, else #f.")
"Return @code{#t} iff @var{x} is a proper list, else @code{#f}.")
#define FUNC_NAME s_scm_list_p
{
return SCM_BOOL (scm_ilength (x) >= 0);
@ -175,7 +177,7 @@ scm_ilength(SCM sx)
SCM_DEFINE (scm_length, "length", 1, 0, 0,
(SCM lst),
"Return the number of elements in list LST.")
"Return the number of elements in list @var{lst}.")
#define FUNC_NAME s_scm_length
{
int i;
@ -190,20 +192,20 @@ SCM_DEFINE (scm_length, "length", 1, 0, 0,
SCM_DEFINE (scm_append, "append", 0, 0, 1,
(SCM args),
"Returns a list consisting of the elements of the first LIST\n"
"followed by the elements of the other LISTs.\n\n"
"Return a list consisting of the elements the lists passed as\n"
"arguments.\n"
"@example\n"
" (append '(x) '(y)) => (x y)\n"
" (append '(a) '(b c d)) => (a b c d)\n"
" (append '(a (b)) '((c))) => (a (b) (c))\n"
"@end example\n\n"
"The resulting list is always newly allocated, except that it shares\n"
"structure with the last LIST argument. The last argument may\n"
"actually be any object; an improper list results if the last\n"
"argument is not a proper list.\n\n"
"(append '(x) '(y)) @result{} (x y)\n"
"(append '(a) '(b c d)) @result{} (a b c d)\n"
"(append '(a (b)) '((c))) @result{} (a (b) (c))\n"
"@end example\n"
"The resulting list is always newly allocated, except that it\n"
"shares structure with the last list argument. The last\n"
"argument may actually be any object; an improper list results\n"
"if the last argument is not a proper list.\n"
"@example\n"
" (append '(a b) '(c . d)) => (a b c . d)\n"
" (append '() 'a) => a\n"
"(append '(a b) '(c . d)) @result{} (a b c . d)\n"
"(append '() 'a) @result{} a\n"
"@end example")
#define FUNC_NAME s_scm_append
{
@ -292,7 +294,8 @@ SCM_DEFINE (scm_last_pair, "last-pair", 1, 0, 0,
SCM_DEFINE (scm_reverse, "reverse", 1, 0, 0,
(SCM lst),
"Return a new list that contains the elements of LST but in reverse order.")
"Return a new list that contains the elements of @var{lst} but\n"
"in reverse order.")
#define FUNC_NAME s_scm_reverse
{
SCM result = SCM_EOL;
@ -352,7 +355,7 @@ SCM_DEFINE (scm_reverse_x, "reverse!", 1, 1, 0,
SCM_DEFINE (scm_list_ref, "list-ref", 2, 0, 0,
(SCM list, SCM k),
"Return the Kth element from LIST.")
"Return the @var{k}th element from @var{list}.")
#define FUNC_NAME s_scm_list_ref
{
SCM lst = list;
@ -580,11 +583,12 @@ scm_c_memq (SCM obj, SCM list)
SCM_DEFINE (scm_memq, "memq", 2, 0, 0,
(SCM x, SCM lst),
"Return the first sublist of LST whose car is `eq?' to X\n"
"where the sublists of LST are the non-empty lists returned\n"
"by `(list-tail LST K)' for K less than the length of LST. If\n"
"X does not occur in LST, then `#f' (not the empty list) is\n"
"returned.")
"Return the first sublist of @var{lst} whose car is @code{eq?}\n"
"to @var{x} where the sublists of @var{lst} are the non-empty\n"
"lists returned by @code{(list-tail @var{lst} @var{k})} for\n"
"@var{k} less than the length of @var{lst}. If @var{x} does not\n"
"occur in @var{lst}, then @code{#f} (not the empty list) is\n"
"returned.")
#define FUNC_NAME s_scm_memq
{
SCM_VALIDATE_LIST (2, lst);
@ -596,11 +600,12 @@ SCM_DEFINE (scm_memq, "memq", 2, 0, 0,
SCM_DEFINE (scm_memv, "memv", 2, 0, 0,
(SCM x, SCM lst),
"Return the first sublist of LST whose car is `eqv?' to X\n"
"where the sublists of LST are the non-empty lists returned\n"
"by `(list-tail LST K)' for K less than the length of LST. If\n"
"X does not occur in LST, then `#f' (not the empty list) is\n"
"returned.")
"Return the first sublist of @var{lst} whose car is @code{eqv?}\n"
"to @var{x} where the sublists of @var{lst} are the non-empty\n"
"lists returned by @code{(list-tail @var{lst} @var{k})} for\n"
"@var{k} less than the length of @var{lst}. If @var{x} does not\n"
"occur in @var{lst}, then @code{#f} (not the empty list) is\n"
"returned.")
#define FUNC_NAME s_scm_memv
{
SCM_VALIDATE_LIST (2, lst);
@ -616,11 +621,12 @@ SCM_DEFINE (scm_memv, "memv", 2, 0, 0,
SCM_DEFINE (scm_member, "member", 2, 0, 0,
(SCM x, SCM lst),
"Return the first sublist of LST whose car is `equal?' to X\n"
"where the sublists of LST are the non-empty lists returned\n"
"by `(list-tail LST K)' for K less than the length of LST. If\n"
"X does not occur in LST, then `#f' (not the empty list) is\n"
"returned.")
"Return the first sublist of @var{lst} whose car is\n"
"@code{equal?} to @var{x} where the sublists of @var{lst} are\n"
"the non-empty lists returned by @code{(list-tail @var{lst}\n"
"@var{k})} for @var{k} less than the length of @var{lst}. If\n"
"@var{x} does not occur in @var{lst}, then @code{#f} (not the\n"
"empty list) is returned.")
#define FUNC_NAME s_scm_member
{
SCM_VALIDATE_LIST (2, lst);
@ -668,8 +674,9 @@ SCM_DEFINE (scm_delq_x, "delq!", 2, 0, 0,
SCM_DEFINE (scm_delv_x, "delv!", 2, 0, 0,
(SCM item, SCM lst),
"Destructively remove all elements from LST that are `eqv?' to ITEM.")
(SCM item, SCM lst),
"Destructively remove all elements from @var{lst} that are\n"
"@code{eqv?} to @var{item}.")
#define FUNC_NAME s_scm_delv_x
{
SCM walk;
@ -692,8 +699,9 @@ SCM_DEFINE (scm_delv_x, "delv!", 2, 0, 0,
SCM_DEFINE (scm_delete_x, "delete!", 2, 0, 0,
(SCM item, SCM lst),
"Destructively remove all elements from LST that are `equal?' to ITEM.")
(SCM item, SCM lst),
"Destructively remove all elements from @var{lst} that are\n"
"@code{equal?} to @var{item}.")
#define FUNC_NAME s_scm_delete_x
{
SCM walk;
@ -719,10 +727,10 @@ SCM_DEFINE (scm_delete_x, "delete!", 2, 0, 0,
SCM_DEFINE (scm_delq, "delq", 2, 0, 0,
(SCM item, SCM lst),
"Return a newly-created copy of @var{lst} with elements `eq?' to @var{item} removed.\n"
"This procedure mirrors @code{memq}:\n"
"@code{delq} compares elements of @var{lst} against @var{item} with\n"
"@code{eq?}.")
"Return a newly-created copy of @var{lst} with elements\n"
"@code{eq?} to @var{item} removed. This procedure mirrors\n"
"@code{memq}: @code{delq} compares elements of @var{lst} against\n"
"@var{item} with @code{eq?}.")
#define FUNC_NAME s_scm_delq
{
SCM copy = scm_list_copy (lst);
@ -732,10 +740,10 @@ SCM_DEFINE (scm_delq, "delq", 2, 0, 0,
SCM_DEFINE (scm_delv, "delv", 2, 0, 0,
(SCM item, SCM lst),
"Return a newly-created copy of @var{lst} with elements `eqv?' to @var{item} removed.\n"
"This procedure mirrors @code{memv}:\n"
"@code{delv} compares elements of @var{lst} against @var{item} with\n"
"@code{eqv?}.")
"Return a newly-created copy of @var{lst} with elements\n"
"@code{eqv?} to @var{item} removed. This procedure mirrors\n"
"@code{memv}: @code{delv} compares elements of @var{lst} against\n"
"@var{item} with @code{eqv?}.")
#define FUNC_NAME s_scm_delv
{
SCM copy = scm_list_copy (lst);
@ -745,10 +753,10 @@ SCM_DEFINE (scm_delv, "delv", 2, 0, 0,
SCM_DEFINE (scm_delete, "delete", 2, 0, 0,
(SCM item, SCM lst),
"Return a newly-created copy of @var{lst} with elements `equal?' to @var{item} removed.\n"
"This procedure mirrors @code{member}:\n"
"@code{delete} compares elements of @var{lst} against @var{item} with\n"
"@code{equal?}.")
"Return a newly-created copy of @var{lst} with elements\n"
"@code{equal?} to @var{item} removed. This procedure mirrors\n"
"@code{member}: @code{delete} compares elements of @var{lst}\n"
"against @var{item} with @code{equal?}.")
#define FUNC_NAME s_scm_delete
{
SCM copy = scm_list_copy (lst);
@ -759,8 +767,9 @@ SCM_DEFINE (scm_delete, "delete", 2, 0, 0,
SCM_DEFINE (scm_delq1_x, "delq1!", 2, 0, 0,
(SCM item, SCM lst),
"Like `delq!', but only deletes the first occurrence of ITEM from LST.\n"
"Tests for equality using `eq?'. See also `delv1!' and `delete1!'.")
"Like @code{delq!}, but only deletes the first occurrence of\n"
"@var{item} from @var{lst}. Tests for equality using\n"
"@code{eq?}. See also @code{delv1!} and @code{delete1!}.")
#define FUNC_NAME s_scm_delq1_x
{
SCM walk;
@ -786,8 +795,9 @@ SCM_DEFINE (scm_delq1_x, "delq1!", 2, 0, 0,
SCM_DEFINE (scm_delv1_x, "delv1!", 2, 0, 0,
(SCM item, SCM lst),
"Like `delv!', but only deletes the first occurrence of ITEM from LST.\n"
"Tests for equality using `eqv?'. See also `delq1!' and `delete1!'.")
"Like @code{delv!}, but only deletes the first occurrence of\n"
"@var{item} from @var{lst}. Tests for equality using\n"
"@code{eqv?}. See also @code{delq1!} and @code{delete1!}.")
#define FUNC_NAME s_scm_delv1_x
{
SCM walk;
@ -813,8 +823,9 @@ SCM_DEFINE (scm_delv1_x, "delv1!", 2, 0, 0,
SCM_DEFINE (scm_delete1_x, "delete1!", 2, 0, 0,
(SCM item, SCM lst),
"Like `delete!', but only deletes the first occurrence of ITEM from LST.\n"
"Tests for equality using `equal?'. See also `delq1!' and `delv1!'.")
"Like @code{delete!}, but only deletes the first occurrence of\n"
"@var{item} from @var{lst}. Tests for equality using\n"
"@code{equal?}. See also @code{delq1!} and @code{delv1!}.")
#define FUNC_NAME s_scm_delete1_x
{
SCM walk;

View file

@ -2865,12 +2865,12 @@ SCM_DEFINE (scm_string_to_number, "string->number", 1, 1, 0,
(SCM string, SCM radix),
"Returns a number of the maximally precise representation\n"
"expressed by the given @var{string}. @var{radix} must be an\n"
"exact integer, either 2, 8, 10, or 16. If supplied, @var{RADIX}\n"
"is a default radix that may be overridden by an explicit\n"
"radix prefix in @var{string} (e.g. \"#o177\"). If @var{radix}\n"
"is not supplied, then the default radix is 10. If string is\n"
"not a syntactically valid notation for a number, then\n"
"@code{string->number} returns @code{#f}. (r5rs)")
"exact integer, either 2, 8, 10, or 16. If supplied, @var{radix}\n"
"is a default radix that may be overridden by an explicit radix\n"
"prefix in @var{string} (e.g. \"#o177\"). If @var{radix} is not\n"
"supplied, then the default radix is 10. If string is not a\n"
"syntactically valid notation for a number, then\n"
"@code{string->number} returns @code{#f}.")
#define FUNC_NAME s_scm_string_to_number
{
SCM answer;

View file

@ -498,8 +498,8 @@ scm_remove_from_port_table (SCM port)
SCM_DEFINE (scm_pt_size, "pt-size", 0, 0, 0,
(),
"Returns the number of ports in the port table.\n"
"`pt-size' is only included in GUILE_DEBUG builds.")
"Returns the number of ports in the port table. @code{pt-size}\n"
"is only included in @code{--enable-guile-debug} builds.")
#define FUNC_NAME s_scm_pt_size
{
return SCM_MAKINUM (scm_port_table_size);
@ -508,8 +508,9 @@ SCM_DEFINE (scm_pt_size, "pt-size", 0, 0, 0,
SCM_DEFINE (scm_pt_member, "pt-member", 1, 0, 0,
(SCM index),
"Returns the port at INDEX in the port table.\n"
"`pt-member' is only included in GUILE_DEBUG builds.")
"Returns the port at @var{index} in the port table.\n"
"@code{pt-member} is only included in\n"
"@code{--enable-guile-debug} builds.")
#define FUNC_NAME s_scm_pt_member
{
int i;
@ -811,8 +812,9 @@ SCM_DEFINE (scm_output_port_p, "output-port?", 1, 0, 0,
SCM_DEFINE (scm_port_p, "port?", 1, 0, 0,
(SCM x),
"Returns a boolean indicating whether @var{x} is a port.\n"
"Equivalent to @code{(or (input-port? X) (output-port? X))}.")
"Returns a boolean indicating whether @var{x} is a port.\n"
"Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
"@var{x}))}.")
#define FUNC_NAME s_scm_port_p
{
return SCM_BOOL (SCM_PORTP (x));

View file

@ -194,8 +194,9 @@ static SCM print_state_pool;
SCM_DEFINE (scm_current_pstate, "current-pstate", 0, 0, 0,
(),
"Return the current-pstate--the `cadr' of the print_state_pool.\n"
"`current-pstate' is only included in GUILE_DEBUG builds.")
"Return the current-pstate -- the cadr of the\n"
"@code{print_state_pool}. @code{current-pstate} is only\n"
"included in @code{--enable-guile-debug} builds.")
#define FUNC_NAME s_scm_current_pstate
{
if (SCM_NNULLP (SCM_CDR (print_state_pool)))

View file

@ -62,18 +62,20 @@
SCM_DEFINE (scm_read_delimited_x, "%read-delimited!", 3, 3, 0,
(SCM delims, SCM str, SCM gobble, SCM port, SCM start, SCM end),
"Read characters from @var{port} into @var{str} until one of the\n"
"characters in the @var{delims} string is encountered. If @var{gobble}\n"
"is true, discard the delimiter character; otherwise, leave it\n"
"in the input stream for the next read.\n"
"If @var{port} is not specified, use the value of\n"
"@code{(current-input-port)}. If @var{start} or @var{end} are specified,\n"
"store data only into the substring of @var{str} bounded by @var{start}\n"
"and @var{end} (which default to the beginning and end of the string,\n"
"respectively).\n\n"
"Return a pair consisting of the delimiter that terminated the string and\n"
"the number of characters read. If reading stopped at the end of file,\n"
"the delimiter returned is the @var{eof-object}; if the string was filled\n"
"without encountering a delimiter, this value is @var{#f}.")
"characters in the @var{delims} string is encountered. If\n"
"@var{gobble} is true, discard the delimiter character;\n"
"otherwise, leave it in the input stream for the next read. If\n"
"@var{port} is not specified, use the value of\n"
"@code{(current-input-port)}. If @var{start} or @var{end} are\n"
"specified, store data only into the substring of @var{str}\n"
"bounded by @var{start} and @var{end} (which default to the\n"
"beginning and end of the string, respectively).\n"
"\n"
" Return a pair consisting of the delimiter that terminated the\n"
"string and the number of characters read. If reading stopped\n"
"at the end of file, the delimiter returned is the\n"
"@var{eof-object}; if the string was filled without encountering\n"
"a delimiter, this value is @code{#f}.")
#define FUNC_NAME s_scm_read_delimited_x
{
long j;

View file

@ -441,8 +441,8 @@ SCM_DEFINE (scm_sleep, "sleep", 1, 0, 0,
#if defined(USE_THREADS) || defined(HAVE_USLEEP)
SCM_DEFINE (scm_usleep, "usleep", 1, 0, 0,
(SCM i),
"Sleep for I microseconds.\n"
"`usleep' is not available on all platforms.")
"Sleep for I microseconds. @code{usleep} is not available on\n"
"all platforms.")
#define FUNC_NAME s_scm_usleep
{
SCM_VALIDATE_INUM_MIN (1,i,0);

View file

@ -100,14 +100,16 @@ scm_i_index (SCM *str, SCM chr, int direction, SCM sub_start,
SCM_DEFINE (scm_string_index, "string-index", 2, 2, 0,
(SCM str, SCM chr, SCM frm, SCM to),
"Return the index of the first occurrence of @var{chr} in @var{str}. The\n"
"optional integer arguments @var{frm} and @var{to} limit the search to\n"
"a portion of the string. This procedure essentially implements the\n"
"@code{index} or @code{strchr} functions from the C library.\n\n"
"(qdocs:) Returns the index of @var{char} in @var{str}, or @code{#f} if the\n"
"@var{char} isn't in @var{str}. If @var{frm} is given and not @code{#f},\n"
"it is used as the starting index; if @var{to} is given and not @var{#f},\n"
"it is used as the ending index (exclusive).\n\n"
"Return the index of the first occurrence of @var{chr} in\n"
"@var{str}. The optional integer arguments @var{frm} and\n"
"@var{to} limit the search to a portion of the string. This\n"
"procedure essentially implements the @code{index} or\n"
"@code{strchr} functions from the C library.\n (qdocs:) Returns\n"
"the index of @var{char} in @var{str}, or @code{#f} if the\n"
"@var{char} isn't in @var{str}. If @var{frm} is given and not\n"
"@code{#f}, it is used as the starting index; if @var{to} is\n"
"given and not @code{#f}, it is used as the ending index\n"
"(exclusive).\n\n"
"@example\n"
"(string-index \"weiner\" #\\e)\n"
"@result{} 1\n\n"

View file

@ -621,9 +621,9 @@ SCM_DEFINE (scm_symbol_binding, "symbol-binding", 2, 0, 0,
SCM_DEFINE (scm_symbol_interned_p, "symbol-interned?", 2, 0, 0,
(SCM o, SCM s),
"Return @var{#t} if @var{obarray} contains a symbol with name\n"
"@var{string}, and @var{#f} otherwise.")
(SCM o, SCM s),
"Return @code{#t} if @var{obarray} contains a symbol with name\n"
"@var{string}, and @code{#f} otherwise.")
#define FUNC_NAME s_scm_symbol_interned_p
{
SCM vcell;
@ -640,12 +640,13 @@ SCM_DEFINE (scm_symbol_interned_p, "symbol-interned?", 2, 0, 0,
SCM_DEFINE (scm_symbol_bound_p, "symbol-bound?", 2, 0, 0,
(SCM o, SCM s),
"Return @var{#t} if @var{obarray} contains a symbol with name\n"
(SCM o, SCM s),
"Return @code{#t} if @var{obarray} contains a symbol with name\n"
"@var{string} bound to a defined value. This differs from\n"
"@var{symbol-interned?} in that the mere mention of a symbol usually causes\n"
"it to be interned; @code{symbol-bound?} determines whether a symbol has\n"
"been given any meaningful value.")
"@var{symbol-interned?} in that the mere mention of a symbol\n"
"usually causes it to be interned; @code{symbol-bound?}\n"
"determines whether a symbol has been given any meaningful\n"
"value.")
#define FUNC_NAME s_scm_symbol_bound_p
{
SCM vcell;

View file

@ -106,8 +106,8 @@ SCM_DEFINE (scm_weak_vector, "weak-vector", 0, 0, 1,
SCM_DEFINE (scm_weak_vector_p, "weak-vector?", 1, 0, 0,
(SCM x),
"Return @var{#t} if @var{obj} is a weak vector. Note that all weak\n"
"hashes are also weak vectors.")
"Return @code{#t} if @var{obj} is a weak vector. Note that all\n"
"weak hashes are also weak vectors.")
#define FUNC_NAME s_scm_weak_vector_p
{
return SCM_BOOL(SCM_WVECTP (x) && !SCM_IS_WHVEC (x));
@ -179,9 +179,9 @@ SCM_DEFINE (scm_weak_key_hash_table_p, "weak-key-hash-table?", 1, 0, 0,
(SCM x),
"@deffnx primitive weak-value-hash-table? obj\n"
"@deffnx primitive doubly-weak-hash-table? obj\n"
"Return @var{#t} if @var{obj} is the specified weak hash table. Note\n"
"that a doubly weak hash table is neither a weak key nor a weak value\n"
"hash table.")
"Return @code{#t} if @var{obj} is the specified weak hash\n"
"table. Note that a doubly weak hash table is neither a weak key\n"
"nor a weak value hash table.")
#define FUNC_NAME s_scm_weak_key_hash_table_p
{
return SCM_BOOL(SCM_WVECTP (x) && SCM_IS_WHVEC(x));
@ -191,7 +191,7 @@ SCM_DEFINE (scm_weak_key_hash_table_p, "weak-key-hash-table?", 1, 0, 0,
SCM_DEFINE (scm_weak_value_hash_table_p, "weak-value-hash-table?", 1, 0, 0,
(SCM x),
"Return @var{#t} if @var{x} is a weak value hash table.")
"Return @code{#t} if @var{x} is a weak value hash table.")
#define FUNC_NAME s_scm_weak_value_hash_table_p
{
return SCM_BOOL(SCM_WVECTP (x) && SCM_IS_WHVEC_V(x));
@ -201,7 +201,7 @@ SCM_DEFINE (scm_weak_value_hash_table_p, "weak-value-hash-table?", 1, 0, 0,
SCM_DEFINE (scm_doubly_weak_hash_table_p, "doubly-weak-hash-table?", 1, 0, 0,
(SCM x),
"Return @var{#t} if @var{x} is a doubly weak hash table.")
"Return @code{#t} if @var{x} is a doubly weak hash table.")
#define FUNC_NAME s_scm_doubly_weak_hash_table_p
{
return SCM_BOOL(SCM_WVECTP (x) && SCM_IS_WHVEC_B (x));