1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-10 05:50:26 +02:00

* Docstring updates.

This commit is contained in:
Neil Jerram 2000-09-02 23:23:16 +00:00
parent 09831f943c
commit 11768c044a
5 changed files with 54 additions and 6 deletions

View file

@ -1,3 +1,46 @@
2000-09-03 Neil Jerram <neil@ossau.uklinux.net>
* vectors.c (scm_vector): Docstring: add @deffnx line for
list->vector.
* unif.c (scm_uniform_vector_ref): Docstring: add @deffnx line for
array-ref.
(scm_array_set_x): Docstring: add @deffnx line for
uniform-array-set!.
* symbols.c (scm_symbol_to_string): Docstring: complete an
incomplete Texinfo reference to a node in r4rs.texi.
(scm_symbol_to_string): Escape double quotes correctly within
docstring.
* struct.c (scm_make_struct, scm_make_vtable_vtable): Docstring
fixes: `@dots' changed to `@dots{}'.
* strop.c (scm_substring_move_x): Docstring: add @deffnx lines for
substring-move-left! and substring-move-right!.
* strings.c (scm_string): Docstring: add @deffnx line for
list->string.
* stime.c (scm_strptime): Fix spelling mistake in docstring.
(scm_current_time): Docstring fix: insert missing newline.
* socket.c (scm_recvfrom): Docstring format fix: missing newline
inserted.
* ramap.c (scm_array_copy_x): Docstring: add @deffnx line for
array-copy-in-order!.
(scm_array_map_x): Docstring: add @deffnx line for
array-map-in-order!.
* posix.c (scm_mknod): Docstring format fix: missing newlines
inserted.
* modules.c (scm_interaction_environment): Docstring fix: add
newlines.
* eval.c (scm_cons_source): Added newly written docstring.
2000-09-03 Michael Livshin <mlivshin@bigfoot.com>
the following changes let Guile get rid of the `allocated' cell

View file

@ -3802,7 +3802,9 @@ SCM_DEFINE (scm_promise_p, "promise?", 1, 0, 0,
SCM_DEFINE (scm_cons_source, "cons-source", 3, 0, 0,
(SCM xorig, SCM x, SCM y),
"")
"Create and return a new pair whose car and cdr are @var{x} and @var{y}.\n"
"Any source properties associated with @var{xorig} are also associated\n"
"with the new pair.")
#define FUNC_NAME s_scm_cons_source
{
SCM p, z;

View file

@ -94,11 +94,11 @@ scm_select_module (SCM module)
SCM_DEFINE (scm_interaction_environment, "interaction-environment", 0, 0, 0,
(),
"This procedure returns a specifier for the environment that"
"contains implementation-defined bindings, typically a superset of"
"those listed in the report. The intent is that this procedure"
"will return the environment in which the implementation would"
"evaluate expressions dynamically typed by the user.")
"This procedure returns a specifier for the environment that contains\n"
"implementation-defined bindings, typically a superset of those listed in\n"
"the report. The intent is that this procedure will return the\n"
"environment in which the implementation would evaluate expressions\n"
"dynamically typed by the user.")
#define FUNC_NAME s_scm_interaction_environment
{
return scm_selected_module ();

View file

@ -95,6 +95,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"
"Returns a newly allocated string composed of the arguments, CHRS.")
#define FUNC_NAME s_scm_string
{

View file

@ -227,6 +227,8 @@ y
SCM_DEFINE (scm_substring_move_x, "substring-move!", 5, 0, 0,
(SCM str1, SCM start1, SCM end1, SCM str2, SCM start2),
"@deffnx primitive substring-move-left! str1 start1 end1 str2 start2\n"
"@deffnx primitive substring-move-right! str1 start1 end1 str2 start2\n"
"Copy the substring of @var{str1} bounded by @var{start1} and @var{end1}\n"
"into @var{str2} beginning at position @var{end2}.\n"
"@code{substring-move-right!} begins copying from the rightmost character\n"