summaryrefslogtreecommitdiff
path: root/libguile
diff options
context:
space:
mode:
authorNeil Jerram <neil@ossau.uklinux.net>2001-11-16 15:04:17 +0000
committerNeil Jerram <neil@ossau.uklinux.net>2001-11-16 15:04:17 +0000
commit8f85c0c6c3eb8de857babc08ca6e832e8a497c44 (patch)
treebb9e336486e81b1733fc2d8c30088be6c3c01096 /libguile
parentcecb4a5e9dbaebcc28f3be0a02feac4263a2cfcc (diff)
downloadguile-8f85c0c6c3eb8de857babc08ca6e832e8a497c44.tar.gz
* Adding C function declarations from the SCM interface to the
reference manual documentation.
Diffstat (limited to 'libguile')
-rw-r--r--libguile/ChangeLog25
-rw-r--r--libguile/alist.c22
-rw-r--r--libguile/eval.c2
-rw-r--r--libguile/feature.c2
-rw-r--r--libguile/filesys.c2
-rw-r--r--libguile/gc.h1
-rw-r--r--libguile/list.c6
-rw-r--r--libguile/macros.c2
-rw-r--r--libguile/net_db.c16
-rw-r--r--libguile/objprop.c4
-rw-r--r--libguile/ports.c8
-rw-r--r--libguile/posix.c2
-rw-r--r--libguile/print.c3
-rw-r--r--libguile/ramap.c12
-rw-r--r--libguile/sort.c7
-rw-r--r--libguile/strings.c5
-rw-r--r--libguile/strop.c8
-rw-r--r--libguile/struct.c2
-rw-r--r--libguile/unif.c25
-rw-r--r--libguile/vectors.c13
-rw-r--r--libguile/version.c6
-rw-r--r--libguile/weaks.c10
22 files changed, 101 insertions, 82 deletions
diff --git a/libguile/ChangeLog b/libguile/ChangeLog
index d89307087..002cd3521 100644
--- a/libguile/ChangeLog
+++ b/libguile/ChangeLog
@@ -1,5 +1,30 @@
2001-11-16 Neil Jerram <neil@ossau.uklinux.net>
+ * gc.h (scm_unhash_name): Old declaration removed.
+
+ * eval.c (s_scm_eval): Change @var{primitive-eval} to
+ @code{primitive-eval}.
+
+ * feature.c, vectors.c, net_db.c, unif.c, weaks.c, struct.c,
+ version.c, alist.c, ports.c, ramap.c, unif.c, strings.c, list.c:
+ Change @deffnx lines in docstrings to say {Scheme Procedure}
+ rather than primitive or procedure.
+
+ * posix.c (scm_execl), filesys.c (scm_close), unif.c
+ (scm_array_set_x, scm_array_contents, scm_uniform_array_read_x,
+ scm_bit_set_star_x, scm_bit_invert_x), ramap.c (scm_array_fill_x,
+ scm_array_for_each, scm_array_index_map_x), vectors.c (scm_vector,
+ scm_make_vector, scm_vector_to_list, scm_vector_fill_x), strop.c
+ (scm_string_split, scm_string_ci_to_symbol), strings.c
+ (scm_string_p), sort.c (scm_merge), print.c (scm_newline),
+ macros.c (scm_macro_type), alist.c (scm_acons, scm_assq):
+ Docstring fixes and improvements reflecting edits that have been
+ made in the reference manual source.
+
+ * objprop.c (scm_object_properties, scm_set_object_properties_x,
+ scm_object_property, scm_set_object_property_x): Remove invalid
+ @deffnx lines for corresponding procedure property primitives.
+
These changes add a @deffnx C function declaration and function
index entries for each Guile primitive to the copy of the doc
snarf output that is used for reference manual synchronization.
diff --git a/libguile/alist.c b/libguile/alist.c
index e2fa86068..9bb44cca8 100644
--- a/libguile/alist.c
+++ b/libguile/alist.c
@@ -52,7 +52,7 @@
SCM_DEFINE (scm_acons, "acons", 3, 0, 0,
(SCM key, SCM value, SCM alist),
- "Adds a new key-value pair to @var{alist}. A new pair is\n"
+ "Add a new key-value pair to @var{alist}. A new pair is\n"
"created whose car is @var{key} and whose cdr is @var{value}, and the\n"
"pair is consed onto @var{alist}, and the new list is returned. This\n"
"function is @emph{not} destructive; @var{alist} is not modified.")
@@ -133,14 +133,14 @@ SCM_DEFINE (scm_sloppy_assoc, "sloppy-assoc", 2, 0, 0,
SCM_DEFINE (scm_assq, "assq", 2, 0, 0,
(SCM key, SCM alist),
- "@deffnx primitive assv key alist\n"
- "@deffnx primitive assoc key alist\n"
- "Fetches the entry in @var{alist} that is associated with @var{key}. To\n"
+ "@deffnx {Scheme Procedure} assv key alist\n"
+ "@deffnx {Scheme Procedure} assoc key alist\n"
+ "Fetch the entry in @var{alist} that is associated with @var{key}. To\n"
"decide whether the argument @var{key} matches a particular entry in\n"
"@var{alist}, @code{assq} compares keys with @code{eq?}, @code{assv}\n"
"uses @code{eqv?} and @code{assoc} uses @code{equal?}. If @var{key}\n"
"cannot be found in @var{alist} (according to whichever equality\n"
- "predicate is in use), then @code{#f} is returned. These functions\n"
+ "predicate is in use), then return @code{#f}. These functions\n"
"return the entire alist entry found (i.e. both the key and the value).")
#define FUNC_NAME s_scm_assq
{
@@ -218,8 +218,8 @@ SCM_DEFINE (scm_assoc, "assoc", 2, 0, 0,
*/
SCM_DEFINE (scm_assq_ref, "assq-ref", 2, 0, 0,
(SCM alist, SCM key),
- "@deffnx primitive assv-ref alist key\n"
- "@deffnx primitive assoc-ref alist key\n"
+ "@deffnx {Scheme Procedure} assv-ref alist key\n"
+ "@deffnx {Scheme Procedure} assoc-ref alist key\n"
"Like @code{assq}, @code{assv} and @code{assoc}, except that only the\n"
"value associated with @var{key} in @var{alist} is returned. These\n"
"functions are equivalent to\n\n"
@@ -282,8 +282,8 @@ SCM_DEFINE (scm_assoc_ref, "assoc-ref", 2, 0, 0,
SCM_DEFINE (scm_assq_set_x, "assq-set!", 3, 0, 0,
(SCM alist, SCM key, SCM val),
- "@deffnx primitive assv-set! alist key value\n"
- "@deffnx primitive assoc-set! alist key value\n"
+ "@deffnx {Scheme Procedure} assv-set! alist key value\n"
+ "@deffnx {Scheme Procedure} assoc-set! alist key value\n"
"Reassociate @var{key} in @var{alist} with @var{value}: find any existing\n"
"@var{alist} entry for @var{key} and associate it with the new\n"
"@var{value}. If @var{alist} does not contain an entry for @var{key},\n"
@@ -347,8 +347,8 @@ SCM_DEFINE (scm_assoc_set_x, "assoc-set!", 3, 0, 0,
SCM_DEFINE (scm_assq_remove_x, "assq-remove!", 2, 0, 0,
(SCM alist, SCM key),
- "@deffnx primitive assv-remove! alist key\n"
- "@deffnx primitive assoc-remove! alist key\n"
+ "@deffnx {Scheme Procedure} assv-remove! alist key\n"
+ "@deffnx {Scheme Procedure} assoc-remove! alist key\n"
"Delete the first entry in @var{alist} associated with @var{key}, and return\n"
"the resulting alist.")
#define FUNC_NAME s_scm_assq_remove_x
diff --git a/libguile/eval.c b/libguile/eval.c
index 6a05083fa..2977da696 100644
--- a/libguile/eval.c
+++ b/libguile/eval.c
@@ -4069,7 +4069,7 @@ SCM_DEFINE (scm_eval, "eval", 2, 0, 0,
(SCM exp, SCM module),
"Evaluate @var{exp}, a list representing a Scheme expression,\n"
"in the top-level environment specified by @var{module}.\n"
- "While @var{exp} is evaluated (using @var{primitive-eval}),\n"
+ "While @var{exp} is evaluated (using @code{primitive-eval}),\n"
"@var{module} is made the current module. The current module\n"
"is reset to its previous value when @var{eval} returns.")
#define FUNC_NAME s_scm_eval
diff --git a/libguile/feature.c b/libguile/feature.c
index 30f5325c3..5748fd30b 100644
--- a/libguile/feature.c
+++ b/libguile/feature.c
@@ -70,7 +70,7 @@ scm_add_feature (const char *str)
SCM_DEFINE (scm_program_arguments, "program-arguments", 0, 0, 0,
(),
- "@deffnx procedure command-line\n"
+ "@deffnx {Scheme Procedure} command-line\n"
"Return the list of command line arguments passed to Guile, as a list of\n"
"strings. The list includes the invoked program name, which is usually\n"
"@code{\"guile\"}, but excludes switches and parameters for command line\n"
diff --git a/libguile/filesys.c b/libguile/filesys.c
index f891be40e..b8a9aadc9 100644
--- a/libguile/filesys.c
+++ b/libguile/filesys.c
@@ -382,7 +382,7 @@ SCM_DEFINE (scm_open, "open", 2, 1, 0,
SCM_DEFINE (scm_close, "close", 1, 0, 0,
(SCM fd_or_port),
- "Similar to close-port (@pxref{Generic Port Operations, close-port}),\n"
+ "Similar to close-port (@pxref{Closing, close-port}),\n"
"but also works on file descriptors. A side\n"
"effect of closing a file descriptor is that any ports using that file\n"
"descriptor are moved to a different file descriptor and have\n"
diff --git a/libguile/gc.h b/libguile/gc.h
index c392b5d07..5e2a01ec4 100644
--- a/libguile/gc.h
+++ b/libguile/gc.h
@@ -351,7 +351,6 @@ SCM_API void scm_assert_cell_valid (SCM);
SCM_API SCM scm_set_debug_cell_accesses_x (SCM flag);
#endif
SCM_API SCM scm_object_address (SCM obj);
-SCM_API SCM scm_unhash_name (SCM name);
SCM_API SCM scm_gc_stats (void);
SCM_API SCM scm_gc (void);
SCM_API void scm_gc_for_alloc (struct scm_t_freelist *freelist);
diff --git a/libguile/list.c b/libguile/list.c
index a2f29f034..b709b882d 100644
--- a/libguile/list.c
+++ b/libguile/list.c
@@ -445,7 +445,7 @@ SCM_REGISTER_PROC(s_list_cdr_ref, "list-cdr-ref", 2, 0, 0, scm_list_tail);
SCM_DEFINE (scm_list_tail, "list-tail", 2, 0, 0,
(SCM lst, SCM k),
- "@deffnx primitive list-cdr-ref lst k\n"
+ "@deffnx {Scheme Procedure} list-cdr-ref lst k\n"
"Return the \"tail\" of @var{lst} beginning with its @var{k}th element.\n"
"The first element of the list is considered to be element 0.\n\n"
"@code{list-tail} and @code{list-cdr-ref} are identical. It may help to\n"
@@ -628,8 +628,8 @@ SCM_DEFINE (scm_member, "member", 2, 0, 0,
SCM_DEFINE (scm_delq_x, "delq!", 2, 0, 0,
(SCM item, SCM lst),
- "@deffnx primitive delv! item lst\n"
- "@deffnx primitive delete! item lst\n"
+ "@deffnx {Scheme Procedure} delv! item lst\n"
+ "@deffnx {Scheme Procedure} delete! item lst\n"
"These procedures are destructive versions of @code{delq}, @code{delv}\n"
"and @code{delete}: they modify the pointers in the existing @var{lst}\n"
"rather than creating a new list. Caveat evaluator: Like other\n"
diff --git a/libguile/macros.c b/libguile/macros.c
index 8f011c055..aac969fdb 100644
--- a/libguile/macros.c
+++ b/libguile/macros.c
@@ -175,7 +175,7 @@ SCM_DEFINE (scm_macro_type, "macro-type", 1, 0, 0,
(SCM m),
"Return one of the symbols @code{syntax}, @code{macro} or\n"
"@code{macro!}, depending on whether @var{m} is a syntax\n"
- "tranformer, a regular macro, or a memoizing macro,\n"
+ "transformer, a regular macro, or a memoizing macro,\n"
"respectively. If @var{m} is not a macro, @code{#f} is\n"
"returned.")
#define FUNC_NAME s_scm_macro_type
diff --git a/libguile/net_db.c b/libguile/net_db.c
index 8afd9244c..d32819ee8 100644
--- a/libguile/net_db.c
+++ b/libguile/net_db.c
@@ -136,8 +136,8 @@ static void scm_resolv_error (const char *subr, SCM bad_value)
SCM_DEFINE (scm_gethost, "gethost", 0, 1, 0,
(SCM host),
- "@deffnx procedure gethostbyname hostname\n"
- "@deffnx procedure gethostbyaddr address\n"
+ "@deffnx {Scheme Procedure} gethostbyname hostname\n"
+ "@deffnx {Scheme Procedure} gethostbyaddr address\n"
"Look up a host by name or address, returning a host object. The\n"
"@code{gethost} procedure will accept either a string name or an integer\n"
"address; if given no arguments, it behaves like @code{gethostent} (see\n"
@@ -219,8 +219,8 @@ SCM_DEFINE (scm_gethost, "gethost", 0, 1, 0,
#if defined(HAVE_GETNETENT) && defined(HAVE_GETNETBYNAME) && defined(HAVE_GETNETBYADDR)
SCM_DEFINE (scm_getnet, "getnet", 0, 1, 0,
(SCM net),
- "@deffnx procedure getnetbyname net-name\n"
- "@deffnx procedure getnetbyaddr net-number\n"
+ "@deffnx {Scheme Procedure} getnetbyname net-name\n"
+ "@deffnx {Scheme Procedure} getnetbyaddr net-number\n"
"Look up a network by name or net number in the network database. The\n"
"@var{net-name} argument must be a string, and the @var{net-number}\n"
"argument must be an integer. @code{getnet} will accept either type of\n"
@@ -269,8 +269,8 @@ SCM_DEFINE (scm_getnet, "getnet", 0, 1, 0,
#ifdef HAVE_GETPROTOENT
SCM_DEFINE (scm_getproto, "getproto", 0, 1, 0,
(SCM protocol),
- "@deffnx procedure getprotobyname name\n"
- "@deffnx procedure getprotobynumber number\n"
+ "@deffnx {Scheme Procedure} getprotobyname name\n"
+ "@deffnx {Scheme Procedure} getprotobynumber number\n"
"Look up a network protocol by name or by number. @code{getprotobyname}\n"
"takes a string argument, and @code{getprotobynumber} takes an integer\n"
"argument. @code{getproto} will accept either type, behaving like\n"
@@ -332,8 +332,8 @@ scm_return_entry (struct servent *entry)
SCM_DEFINE (scm_getserv, "getserv", 0, 2, 0,
(SCM name, SCM protocol),
- "@deffnx procedure getservbyname name protocol\n"
- "@deffnx procedure getservbyport port protocol\n"
+ "@deffnx {Scheme Procedure} getservbyname name protocol\n"
+ "@deffnx {Scheme Procedure} getservbyport port protocol\n"
"Look up a network service by name or by service number, and return a\n"
"network service object. The @var{protocol} argument specifies the name\n"
"of the desired protocol; if the protocol found in the network service\n"
diff --git a/libguile/objprop.c b/libguile/objprop.c
index 4d5dd79cb..aa3883165 100644
--- a/libguile/objprop.c
+++ b/libguile/objprop.c
@@ -56,7 +56,6 @@
SCM_DEFINE (scm_object_properties, "object-properties", 1, 0, 0,
(SCM obj),
- "@deffnx primitive procedure-properties obj\n"
"Return @var{obj}'s property list.")
#define FUNC_NAME s_scm_object_properties
{
@@ -67,7 +66,6 @@ SCM_DEFINE (scm_object_properties, "object-properties", 1, 0, 0,
SCM_DEFINE (scm_set_object_properties_x, "set-object-properties!", 2, 0, 0,
(SCM obj, SCM alist),
- "@deffnx primitive set-procedure-properties! obj alist\n"
"Set @var{obj}'s property list to @var{alist}.")
#define FUNC_NAME s_scm_set_object_properties_x
{
@@ -79,7 +77,6 @@ SCM_DEFINE (scm_set_object_properties_x, "set-object-properties!", 2, 0, 0,
SCM_DEFINE (scm_object_property, "object-property", 2, 0, 0,
(SCM obj, SCM key),
- "@deffnx primitive procedure-property obj key\n"
"Return the property of @var{obj} with name @var{key}.")
#define FUNC_NAME s_scm_object_property
{
@@ -91,7 +88,6 @@ SCM_DEFINE (scm_object_property, "object-property", 2, 0, 0,
SCM_DEFINE (scm_set_object_property_x, "set-object-property!", 3, 0, 0,
(SCM obj, SCM key, SCM value),
- "@deffnx primitive set-procedure-property! obj key value\n"
"In @var{obj}'s property list, set the property named @var{key}\n"
"to @var{value}.")
#define FUNC_NAME s_scm_set_object_property_x
diff --git a/libguile/ports.c b/libguile/ports.c
index 0250f503c..6e79e9ab7 100644
--- a/libguile/ports.c
+++ b/libguile/ports.c
@@ -395,8 +395,8 @@ SCM_DEFINE (scm_current_load_port, "current-load-port", 0, 0, 0,
SCM_DEFINE (scm_set_current_input_port, "set-current-input-port", 1, 0, 0,
(SCM port),
- "@deffnx primitive set-current-output-port port\n"
- "@deffnx primitive set-current-error-port port\n"
+ "@deffnx {Scheme Procedure} set-current-output-port port\n"
+ "@deffnx {Scheme Procedure} set-current-error-port port\n"
"Change the ports returned by @code{current-input-port},\n"
"@code{current-output-port} and @code{current-error-port}, respectively,\n"
"so that they use the supplied @var{port} for input or output.")
@@ -1400,7 +1400,7 @@ SCM_DEFINE (scm_set_port_line_x, "set-port-line!", 2, 0, 0,
SCM_DEFINE (scm_port_column, "port-column", 1, 0, 0,
(SCM port),
- "@deffnx primitive port-line port\n"
+ "@deffnx {Scheme Procedure} port-line port\n"
"Return the current column number or line number of @var{port},\n"
"using the current input port if none is specified. If the number is\n"
"unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
@@ -1419,7 +1419,7 @@ SCM_DEFINE (scm_port_column, "port-column", 1, 0, 0,
SCM_DEFINE (scm_set_port_column_x, "set-port-column!", 2, 0, 0,
(SCM port, SCM column),
- "@deffnx primitive set-port-line! port line\n"
+ "@deffnx {Scheme Procedure} set-port-line! port line\n"
"Set the current column or line number of @var{port}, using the\n"
"current input port if none is specified.")
#define FUNC_NAME s_scm_set_port_column_x
diff --git a/libguile/posix.c b/libguile/posix.c
index acec88b08..6e2393570 100644
--- a/libguile/posix.c
+++ b/libguile/posix.c
@@ -867,7 +867,7 @@ SCM_DEFINE (scm_execl, "execl", 1, 0, 1,
"The remaining arguments are supplied to the process; from a C program\n"
"they are accessable as the @code{argv} argument to @code{main}.\n"
"Conventionally the first @var{arg} is the same as @var{path}.\n"
- "All arguments must be strings. \n\n"
+ "All arguments must be strings.\n\n"
"If @var{arg} is missing, @var{path} is executed with a null\n"
"argument list, which may have system-dependent side-effects.\n\n"
"This procedure is currently implemented using the @code{execv} system\n"
diff --git a/libguile/print.c b/libguile/print.c
index 369b112bb..3e7849314 100644
--- a/libguile/print.c
+++ b/libguile/print.c
@@ -992,7 +992,8 @@ SCM_DEFINE (scm_simple_format, "simple-format", 2, 0, 1,
SCM_DEFINE (scm_newline, "newline", 0, 1, 0,
(SCM port),
- "Send a newline to @var{port}.")
+ "Send a newline to @var{port}.\n"
+ "If @var{port} is omitted, send to the current output port.")
#define FUNC_NAME s_scm_newline
{
if (SCM_UNBNDP (port))
diff --git a/libguile/ramap.c b/libguile/ramap.c
index 4e0e712c8..9cc642f0b 100644
--- a/libguile/ramap.c
+++ b/libguile/ramap.c
@@ -458,7 +458,7 @@ scm_ramapc (int (*cproc)(), SCM data, SCM ra0, SCM lra, const char *what)
SCM_DEFINE (scm_array_fill_x, "array-fill!", 2, 0, 0,
(SCM ra, SCM fill),
- "Stores @var{fill} in every element of @var{array}. The value returned\n"
+ "Store @var{fill} in every element of @var{array}. The value returned\n"
"is unspecified.")
#define FUNC_NAME s_scm_array_fill_x
{
@@ -829,8 +829,8 @@ SCM_REGISTER_PROC(s_array_copy_in_order_x, "array-copy-in-order!", 2, 0, 0, scm_
SCM_DEFINE (scm_array_copy_x, "array-copy!", 2, 0, 0,
(SCM src, SCM dst),
- "@deffnx primitive array-copy-in-order! src dst\n"
- "Copies every element from vector or array @var{source} to the\n"
+ "@deffnx {Scheme Procedure} array-copy-in-order! src dst\n"
+ "Copy every element from vector or array @var{source} to the\n"
"corresponding element of @var{destination}. @var{destination} must have\n"
"the same rank as @var{source}, and be at least as large in each\n"
"dimension. The order is unspecified.")
@@ -1512,7 +1512,7 @@ SCM_REGISTER_PROC(s_array_map_in_order_x, "array-map-in-order!", 2, 0, 1, scm_ar
SCM_DEFINE (scm_array_map_x, "array-map!", 2, 0, 1,
(SCM ra0, SCM proc, SCM lra),
- "@deffnx primitive array-map-in-order! ra0 proc . lra\n"
+ "@deffnx {Scheme Procedure} array-map-in-order! ra0 proc . lra\n"
"@var{array1}, @dots{} must have the same number of dimensions as\n"
"@var{array0} and have a range for each index which includes the range\n"
"for the corresponding index in @var{array0}. @var{proc} is applied to\n"
@@ -1664,7 +1664,7 @@ rafe (SCM ra0,SCM proc,SCM ras)
SCM_DEFINE (scm_array_for_each, "array-for-each", 2, 0, 1,
(SCM proc, SCM ra0, SCM lra),
- "@var{proc} is applied to each tuple of elements of @var{array0} @dots{}\n"
+ "Apply @var{proc} to each tuple of elements of @var{array0} @dots{}\n"
"in row-major order. The value returned is unspecified.")
#define FUNC_NAME s_scm_array_for_each
{
@@ -1677,7 +1677,7 @@ SCM_DEFINE (scm_array_for_each, "array-for-each", 2, 0, 1,
SCM_DEFINE (scm_array_index_map_x, "array-index-map!", 2, 0, 0,
(SCM ra, SCM proc),
- "applies @var{proc} to the indices of each element of @var{array} in\n"
+ "Apply @var{proc} to the indices of each element of @var{array} in\n"
"turn, storing the result in the corresponding element. The value\n"
"returned and the order of application are unspecified.\n\n"
"One can implement @var{array-indexes} as\n"
diff --git a/libguile/sort.c b/libguile/sort.c
index 70de17505..7519ed2f2 100644
--- a/libguile/sort.c
+++ b/libguile/sort.c
@@ -516,9 +516,10 @@ SCM_DEFINE (scm_sorted_p, "sorted?", 2, 0, 0,
Note: this does _not_ accept vectors. */
SCM_DEFINE (scm_merge, "merge", 3, 0, 0,
(SCM alist, SCM blist, SCM less),
- "Takes two lists @var{alist} and @var{blist} such that\n"
- "@code{(sorted? alist less?)} and @code{(sorted? blist less?)} and\n"
- "returns a new list in which the elements of @var{alist} and\n"
+ "Merge two already sorted lists into one.\n"
+ "Given two lists @var{alist} and @var{blist}, such that\n"
+ "@code{(sorted? alist less?)} and @code{(sorted? blist less?)},\n"
+ "return a new list in which the elements of @var{alist} and\n"
"@var{blist} have been stably interleaved so that\n"
"@code{(sorted? (merge alist blist less?) less?)}.\n"
"Note: this does _not_ accept vectors.")
diff --git a/libguile/strings.c b/libguile/strings.c
index eef9f4a7f..8bd7de872 100644
--- a/libguile/strings.c
+++ b/libguile/strings.c
@@ -58,8 +58,7 @@
SCM_DEFINE (scm_string_p, "string?", 1, 0, 0,
(SCM obj),
- "Return @code{#t} iff @var{obj} is a string, else returns\n"
- "@code{#f}.")
+ "Return @code{#t} iff @var{obj} is a string, else @code{#f}.")
#define FUNC_NAME s_scm_string_p
{
return SCM_BOOL (SCM_STRINGP (obj));
@@ -71,7 +70,7 @@ SCM_REGISTER_PROC (s_scm_list_to_string, "list->string", 1, 0, 0, scm_string);
SCM_DEFINE (scm_string, "string", 0, 0, 1,
(SCM chrs),
- "@deffnx primitive list->string chrs\n"
+ "@deffnx {Scheme Procedure} list->string chrs\n"
"Return a newly allocated string composed of the arguments,\n"
"@var{chrs}.")
#define FUNC_NAME s_scm_string
diff --git a/libguile/strop.c b/libguile/strop.c
index 1271dea08..89cd02f62 100644
--- a/libguile/strop.c
+++ b/libguile/strop.c
@@ -472,15 +472,15 @@ SCM_DEFINE (scm_string_split, "string-split", 2, 0, 0,
"result list.\n"
"\n"
"@lisp\n"
- "(string-split \"root:x:0:0:root:/root:/bin/bash\" #\:)\n"
+ "(string-split \"root:x:0:0:root:/root:/bin/bash\" #\\:)\n"
"@result{}\n"
"(\"root\" \"x\" \"0\" \"0\" \"root\" \"/root\" \"/bin/bash\")\n"
"\n"
- "(string-split \"::\" #\:)\n"
+ "(string-split \"::\" #\\:)\n"
"@result{}\n"
"(\"\" \"\" \"\")\n"
"\n"
- "(string-split \"\" #\:)\n"
+ "(string-split \"\" #\\:)\n"
"@result{}\n"
"(\"\")\n"
"@end lisp")
@@ -518,7 +518,7 @@ SCM_DEFINE (scm_string_ci_to_symbol, "string-ci->symbol", 1, 0, 0,
(SCM str),
"Return the symbol whose name is @var{str}. @var{str} is\n"
"converted to lowercase before the conversion is done, if Guile\n"
- "is currently reading symbols case--insensitively.")
+ "is currently reading symbols case-insensitively.")
#define FUNC_NAME s_scm_string_ci_to_symbol
{
return scm_string_to_symbol (SCM_CASE_INSENSITIVE_P
diff --git a/libguile/struct.c b/libguile/struct.c
index f24fefdb2..9a580cb41 100644
--- a/libguile/struct.c
+++ b/libguile/struct.c
@@ -560,7 +560,7 @@ SCM_DEFINE (scm_make_vtable_vtable, "make-vtable-vtable", 2, 0, 1,
SCM_DEFINE (scm_struct_ref, "struct-ref", 2, 0, 0,
(SCM handle, SCM pos),
- "@deffnx primitive struct-set! struct n value\n"
+ "@deffnx {Scheme Procedure} struct-set! struct n value\n"
"Access (or modify) the @var{n}th field of @var{struct}.\n\n"
"If the field is of type 'p', then it can be set to an arbitrary value.\n\n"
"If the field is of type 'u', then it can only be set to a non-negative\n"
diff --git a/libguile/unif.c b/libguile/unif.c
index 138fe36a8..17470207e 100644
--- a/libguile/unif.c
+++ b/libguile/unif.c
@@ -582,7 +582,7 @@ scm_shap2ra (SCM args, const char *what)
SCM_DEFINE (scm_dimensions_to_uniform_array, "dimensions->uniform-array", 2, 1, 0,
(SCM dims, SCM prot, SCM fill),
- "@deffnx primitive make-uniform-vector length prototype [fill]\n"
+ "@deffnx {Scheme Procedure} make-uniform-vector length prototype [fill]\n"
"Create and return a uniform array or vector of type\n"
"corresponding to @var{prototype} with dimensions @var{dims} or\n"
"length @var{length}. If @var{fill} is supplied, it's used to\n"
@@ -1084,7 +1084,7 @@ SCM_REGISTER_PROC(s_array_ref, "array-ref", 1, 0, 1, scm_uniform_vector_ref);
SCM_DEFINE (scm_uniform_vector_ref, "uniform-vector-ref", 2, 0, 0,
(SCM v, SCM args),
- "@deffnx primitive array-ref v . args\n"
+ "@deffnx {Scheme Procedure} array-ref v . args\n"
"Return the element at the @code{(index1, index2)} element in\n"
"@var{array}.")
#define FUNC_NAME s_scm_uniform_vector_ref
@@ -1262,8 +1262,8 @@ SCM_REGISTER_PROC(s_uniform_array_set1_x, "uniform-array-set1!", 3, 0, 0, scm_ar
PROC is used (and it's called from C too). */
SCM_DEFINE (scm_array_set_x, "array-set!", 2, 0, 1,
(SCM v, SCM obj, SCM args),
- "@deffnx primitive uniform-array-set1! v obj args\n"
- "Sets the element at the @code{(index1, index2)} element in @var{array} to\n"
+ "@deffnx {Scheme Procedure} uniform-array-set1! v obj args\n"
+ "Set the element at the @code{(index1, index2)} element in @var{array} to\n"
"@var{new-value}. The value returned by array-set! is unspecified.")
#define FUNC_NAME s_scm_array_set_x
{
@@ -1371,7 +1371,6 @@ SCM_DEFINE (scm_array_set_x, "array-set!", 2, 0, 1,
wouldn't have contiguous elements. */
SCM_DEFINE (scm_array_contents, "array-contents", 1, 1, 0,
(SCM ra, SCM strict),
- "@deffnx primitive array-contents array strict\n"
"If @var{array} may be @dfn{unrolled} into a one dimensional shared array\n"
"without changing their order (last subscript changing fastest), then\n"
"@code{array-contents} returns that shared array, otherwise it returns\n"
@@ -1482,11 +1481,11 @@ scm_ra2contig (SCM ra, int copy)
SCM_DEFINE (scm_uniform_array_read_x, "uniform-array-read!", 1, 3, 0,
(SCM ra, SCM port_or_fd, SCM start, SCM end),
- "@deffnx primitive uniform-vector-read! uve [port-or-fdes] [start] [end]\n"
- "Attempts to read all elements of @var{ura}, in lexicographic order, as\n"
+ "@deffnx {Scheme Procedure} uniform-vector-read! uve [port-or-fdes] [start] [end]\n"
+ "Attempt to read all elements of @var{ura}, in lexicographic order, as\n"
"binary objects from @var{port-or-fdes}.\n"
- "If an end of file is encountered during\n"
- "uniform-array-read! the objects up to that point only are put into @var{ura}\n"
+ "If an end of file is encountered,\n"
+ "the objects up to that point are put into @var{ura}\n"
"(starting at the beginning) and the remainder of the array is\n"
"unchanged.\n\n"
"The optional arguments @var{start} and @var{end} allow\n"
@@ -1650,7 +1649,7 @@ loop:
SCM_DEFINE (scm_uniform_array_write, "uniform-array-write", 1, 3, 0,
(SCM v, SCM port_or_fd, SCM start, SCM end),
- "@deffnx primitive uniform-vector-write uve [port-or-fdes] [start] [end]\n"
+ "@deffnx {Scheme Procedure} uniform-vector-write uve [port-or-fdes] [start] [end]\n"
"Writes all elements of @var{ura} as binary objects to\n"
"@var{port-or-fdes}.\n\n"
"The optional arguments @var{start}\n"
@@ -1890,7 +1889,7 @@ SCM_DEFINE (scm_bit_set_star_x, "bit-set*!", 3, 0, 0,
"length. If @var{bool} is @code{#t}, uve is OR'ed into\n"
"@var{bv}; If @var{bool} is @code{#f}, the inversion of uve is\n"
"AND'ed into @var{bv}.\n\n"
- "If uve is a unsigned integer vector all the elements of uve\n"
+ "If uve is a unsigned long integer vector all the elements of uve\n"
"must be between 0 and the @code{length} of @var{bv}. The bits\n"
"of @var{bv} corresponding to the indexes in uve are set to\n"
"@var{bool}. The return value is unspecified.")
@@ -2011,7 +2010,7 @@ SCM_DEFINE (scm_bit_count_star, "bit-count*", 3, 0, 0,
SCM_DEFINE (scm_bit_invert_x, "bit-invert!", 1, 0, 0,
(SCM v),
- "Modifies @var{bv} by replacing each element with its negation.")
+ "Modify @var{bv} by replacing each element with its negation.")
#define FUNC_NAME s_scm_bit_invert_x
{
long int k;
@@ -2187,7 +2186,7 @@ static int l2ra(SCM lst, SCM ra, unsigned long base, unsigned long k);
SCM_DEFINE (scm_list_to_uniform_array, "list->uniform-array", 3, 0, 0,
(SCM ndim, SCM prot, SCM lst),
- "@deffnx procedure list->uniform-vector prot lst\n"
+ "@deffnx {Scheme Procedure} list->uniform-vector prot lst\n"
"Return a uniform array of the type indicated by prototype\n"
"@var{prot} with elements the same as those of @var{lst}.\n"
"Elements must be of the appropriate type, no coercions are\n"
diff --git a/libguile/vectors.c b/libguile/vectors.c
index cd194a905..36ffda380 100644
--- a/libguile/vectors.c
+++ b/libguile/vectors.c
@@ -83,8 +83,8 @@ SCM_REGISTER_PROC (s_list_to_vector, "list->vector", 1, 0, 0, scm_vector);
*/
SCM_DEFINE (scm_vector, "vector", 0, 0, 1,
(SCM l),
- "@deffnx primitive list->vector l\n"
- "Return a newly allocated vector whose elements contain the\n"
+ "@deffnx {Scheme Procedure} list->vector l\n"
+ "Return a newly allocated vector composed of the\n"
"given arguments. Analogous to @code{list}.\n"
"\n"
"@lisp\n"
@@ -173,8 +173,8 @@ scm_vector_set_x (SCM v, SCM k, SCM obj)
SCM_DEFINE (scm_make_vector, "make-vector", 1, 1, 0,
(SCM k, SCM fill),
"Return a newly allocated vector of @var{k} elements. If a\n"
- "second argument is given, then each element is initialized to\n"
- "@var{fill}. Otherwise the initial contents of each element is\n"
+ "second argument is given, then each position is initialized to\n"
+ "@var{fill}. Otherwise the initial contents of each position is\n"
"unspecified.")
#define FUNC_NAME s_scm_make_vector
{
@@ -226,8 +226,7 @@ scm_c_make_vector (unsigned long int k, SCM fill)
SCM_DEFINE (scm_vector_to_list, "vector->list", 1, 0, 0,
(SCM v),
- "Return a newly allocated list of the objects contained in the\n"
- "elements of @var{vector}.\n"
+ "Return a newly allocated list composed of the elements of @var{v}.\n"
"\n"
"@lisp\n"
"(vector->list '#(dah dah didah)) @result{} (dah dah didah)\n"
@@ -248,7 +247,7 @@ SCM_DEFINE (scm_vector_to_list, "vector->list", 1, 0, 0,
SCM_DEFINE (scm_vector_fill_x, "vector-fill!", 2, 0, 0,
(SCM v, SCM fill),
- "Store @var{fill} in every element of @var{vector}. The value\n"
+ "Store @var{fill} in every position of @var{vector}. The value\n"
"returned by @code{vector-fill!} is unspecified.")
#define FUNC_NAME s_scm_vector_fill_x
{
diff --git a/libguile/version.c b/libguile/version.c
index e1c40b65b..b99d77710 100644
--- a/libguile/version.c
+++ b/libguile/version.c
@@ -94,9 +94,9 @@ SCM_DEFINE (scm_micro_version, "micro-version", 0, 0, 0,
SCM_DEFINE (scm_version, "version", 0, 0, 0,
(),
- "@deffnx primitive major-version\n"
- "@deffnx primitive minor-version\n"
- "@deffnx primitive micro-version\n"
+ "@deffnx {Scheme Procedure} major-version\n"
+ "@deffnx {Scheme Procedure} minor-version\n"
+ "@deffnx {Scheme Procedure} micro-version\n"
"Return a string describing Guile's version number, or its major, minor\n"
"or micro version number, respectively.\n\n"
"@lisp\n"
diff --git a/libguile/weaks.c b/libguile/weaks.c
index d8eb065cd..74ce39703 100644
--- a/libguile/weaks.c
+++ b/libguile/weaks.c
@@ -124,7 +124,7 @@ SCM_REGISTER_PROC(s_list_to_weak_vector, "list->weak-vector", 1, 0, 0, scm_weak_
SCM_DEFINE (scm_weak_vector, "weak-vector", 0, 0, 1,
(SCM l),
- "@deffnx primitive list->weak-vector l\n"
+ "@deffnx {Scheme Procedure} list->weak-vector l\n"
"Construct a weak vector from a list: @code{weak-vector} uses\n"
"the list of its arguments while @code{list->weak-vector} uses\n"
"its only argument @var{l} (a list) to construct a weak vector\n"
@@ -167,8 +167,8 @@ SCM_DEFINE (scm_weak_vector_p, "weak-vector?", 1, 0, 0,
SCM_DEFINE (scm_make_weak_key_hash_table, "make-weak-key-hash-table", 1, 0, 0,
(SCM size),
- "@deffnx primitive make-weak-value-hash-table size\n"
- "@deffnx primitive make-doubly-weak-hash-table size\n"
+ "@deffnx {Scheme Procedure} make-weak-value-hash-table size\n"
+ "@deffnx {Scheme Procedure} make-doubly-weak-hash-table size\n"
"Return a weak hash table with @var{size} buckets. As with any\n"
"hash table, choosing a good size for the table requires some\n"
"caution.\n"
@@ -206,8 +206,8 @@ SCM_DEFINE (scm_make_doubly_weak_hash_table, "make-doubly-weak-hash-table", 1, 0
SCM_DEFINE (scm_weak_key_hash_table_p, "weak-key-hash-table?", 1, 0, 0,
(SCM obj),
- "@deffnx primitive weak-value-hash-table? obj\n"
- "@deffnx primitive doubly-weak-hash-table? obj\n"
+ "@deffnx {Scheme Procedure} weak-value-hash-table? obj\n"
+ "@deffnx {Scheme Procedure} doubly-weak-hash-table? obj\n"
"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.")