diff options
author | Neil Jerram <neil@ossau.uklinux.net> | 2001-11-11 15:01:52 +0000 |
---|---|---|
committer | Neil Jerram <neil@ossau.uklinux.net> | 2001-11-11 15:01:52 +0000 |
commit | 9401323e63278a7053c54565e8d688f6cbe34f54 (patch) | |
tree | 01e0840bac67d78e974b03200f9cf16f894fea37 /libguile | |
parent | a0a9b9ad4263e129e46e31a8c0c2e7775b037ee9 (diff) | |
download | guile-9401323e63278a7053c54565e8d688f6cbe34f54.tar.gz |
* Documentation work.
Diffstat (limited to 'libguile')
-rw-r--r-- | libguile/ChangeLog | 25 | ||||
-rw-r--r-- | libguile/dynwind.c | 4 | ||||
-rw-r--r-- | libguile/extensions.c | 64 | ||||
-rw-r--r-- | libguile/filesys.c | 7 | ||||
-rw-r--r-- | libguile/guardians.c | 2 | ||||
-rw-r--r-- | libguile/hashtab.c | 2 | ||||
-rw-r--r-- | libguile/modules.c | 2 | ||||
-rw-r--r-- | libguile/ports.c | 6 | ||||
-rw-r--r-- | libguile/posix.c | 2 | ||||
-rw-r--r-- | libguile/random.c | 14 | ||||
-rw-r--r-- | libguile/scmsigs.c | 8 | ||||
-rw-r--r-- | libguile/strings.c | 2 | ||||
-rw-r--r-- | libguile/strop.c | 2 | ||||
-rw-r--r-- | libguile/struct.c | 4 | ||||
-rw-r--r-- | libguile/unif.c | 2 | ||||
-rw-r--r-- | libguile/variable.c | 10 |
16 files changed, 92 insertions, 64 deletions
diff --git a/libguile/ChangeLog b/libguile/ChangeLog index 660d22307..0d958e2ae 100644 --- a/libguile/ChangeLog +++ b/libguile/ChangeLog @@ -1,3 +1,28 @@ +2001-11-07 Neil Jerram <neil@ossau.uklinux.net> + + * extensions.c (scm_load_extension): Canonicalize docstring + whitespace. + + * unif.c (scm_uniform_array_write), ports.c + (scm_current_output_port, scm_force_output), dynwind.c + (scm_dynamic_wind), scmsigs.c (scm_setitimer, scm_getitimer), + filesys.c (scm_open, scm_lstat), struct.c + (scm_make_struct_layout), random.c (scm_random, + scm_random_solid_sphere_x, scm_random_hollow_sphere_x, strop.c + (scm_i_index): Remove superfluous whitespace from end of docstring + lines. + + * filesys.c (scm_select), guardians.c (scm_guardian_greedy_p), + strings.c (scm_make_string), variable.c (scm_make_variable, + scm_make_undefined_variable, scm_variable_p, scm_variable_set_x, + scm_variable_bound_p), scmsigs.c (scm_setitimer, scm_getitimer), + posix.c (scm_crypt), struct.c (scm_make_vtable_vtable), hashtab.c + (scm_hash_fold), ports.c (scm_port_for_each): Remove superfluous + newline at end of docstrings. + + * modules.c (scm_set_current_module): Add missing newline to + docstring. + 2001-11-07 Stefan Jahn <stefan@lkcc.org> * win32-socket.[ch]: New files. Defines Winsock-API error codes diff --git a/libguile/dynwind.c b/libguile/dynwind.c index d093861cf..5970dc455 100644 --- a/libguile/dynwind.c +++ b/libguile/dynwind.c @@ -82,7 +82,7 @@ SCM_DEFINE (scm_dynamic_wind, "dynamic-wind", 3, 0, 0, "@lisp\n" "(define x 'normal-binding)\n" "@result{} x\n" - "(define a-cont (call-with-current-continuation \n" + "(define a-cont (call-with-current-continuation\n" " (lambda (escape)\n" " (let ((old-x x))\n" " (dynamic-wind\n" @@ -101,7 +101,7 @@ SCM_DEFINE (scm_dynamic_wind, "dynamic-wind", 3, 0, 0, " ;;\n" " (lambda () (set! x old-x)))))))\n" "\n" - ";; Prints: \n" + ";; Prints:\n" "special-binding\n" ";; Evaluates to:\n" "@result{} a-cont\n" diff --git a/libguile/extensions.c b/libguile/extensions.c index b549f0fc7..48e39420c 100644 --- a/libguile/extensions.c +++ b/libguile/extensions.c @@ -117,36 +117,40 @@ scm_c_load_extension (const char *lib, const char *init) SCM_DEFINE (scm_load_extension, "load-extension", 2, 0, 0, (SCM lib, SCM init), - "Load and initilize the extension designated by LIB and INIT." -"When there is no pre-registered function for LIB/INIT, this is " -"equivalent to " -" " -" (dynamic-call INIT (dynamic-link LIB)) " -" " -"When there is a pre-registered function, that function is called " -"instead. " -" " -"Normally, there is no pre-registered function. This option exists " -"only for situations where dynamic linking is unavailable or unwanted. " -"In that case, you would statically link your program with the desired " -"library, and register its init function right after Guile has been " -"initialized. " -" " -"LIB should be a string denoting a shared library without any file type " -"suffix such as \".so\". The suffix is provided automatically. It " -"should also not contain any directory components. Libraries that " -"implement Guile Extensions should be put into the normal locations for " -"shared libraries. We recommend to use the naming convention " -"libguile-bla-blum for a extension related to a module `(bla blum)'. " -" " -"The normal way for a extension to be used is to write a small Scheme " -"file that defines a module, and to load the extension into this " -"module. When the module is auto-loaded, the extension is loaded as " -"well. For example, " -" " -" (define-module (bla blum)) " -" " -" (load-extension \"libguile-bla-blum\" \"bla_init_blum\")") + "Load and initilize the extension designated by LIB and INIT.\n" + "When there is no pre-registered function for LIB/INIT, this is\n" + "equivalent to\n" + "\n" + "@lisp\n" + "(dynamic-call INIT (dynamic-link LIB))\n" + "@end lisp\n" + "\n" + "When there is a pre-registered function, that function is called\n" + "instead.\n" + "\n" + "Normally, there is no pre-registered function. This option exists\n" + "only for situations where dynamic linking is unavailable or unwanted.\n" + "In that case, you would statically link your program with the desired\n" + "library, and register its init function right after Guile has been\n" + "initialized.\n" + "\n" + "LIB should be a string denoting a shared library without any file type\n" + "suffix such as \".so\". The suffix is provided automatically. It\n" + "should also not contain any directory components. Libraries that\n" + "implement Guile Extensions should be put into the normal locations for\n" + "shared libraries. We recommend to use the naming convention\n" + "libguile-bla-blum for a extension related to a module `(bla blum)'.\n" + "\n" + "The normal way for a extension to be used is to write a small Scheme\n" + "file that defines a module, and to load the extension into this\n" + "module. When the module is auto-loaded, the extension is loaded as\n" + "well. For example,\n" + "\n" + "@lisp\n" + "(define-module (bla blum))\n" + "\n" + "(load-extension \"libguile-bla-blum\" \"bla_init_blum\")\n" + "@end lisp") #define FUNC_NAME s_scm_load_extension { SCM_VALIDATE_STRING (1, lib); diff --git a/libguile/filesys.c b/libguile/filesys.c index 806c8c10f..f891be40e 100644 --- a/libguile/filesys.c +++ b/libguile/filesys.c @@ -336,7 +336,7 @@ SCM_DEFINE (scm_open, "open", 2, 1, 0, "Open the file read-only.\n" "@end defvar\n" "@defvar O_WRONLY\n" - "Open the file write-only. \n" + "Open the file write-only.\n" "@end defvar\n" "@defvar O_RDWR\n" "Open the file read/write.\n" @@ -1129,8 +1129,7 @@ SCM_DEFINE (scm_select, "select", 3, 2, 0, "The @var{usecs} argument is not supported.\n" "Multiple values are returned instead of a list.\n" "Duplicates in the input vectors appear only once in output.\n" - "An additional @code{select!} interface is provided.\n" - ) + "An additional @code{select!} interface is provided.") #define FUNC_NAME s_scm_select { struct timeval timeout; @@ -1387,7 +1386,7 @@ SCM_DEFINE (scm_readlink, "readlink", 1, 0, 0, SCM_DEFINE (scm_lstat, "lstat", 1, 0, 0, (SCM str), "Similar to @code{stat}, but does not follow symbolic links, i.e.,\n" - "it will return information about a symbolic link itself, not the \n" + "it will return information about a symbolic link itself, not the\n" "file it points to. @var{path} must be a string.") #define FUNC_NAME s_scm_lstat { diff --git a/libguile/guardians.c b/libguile/guardians.c index 4703bee74..ad9832539 100644 --- a/libguile/guardians.c +++ b/libguile/guardians.c @@ -374,7 +374,7 @@ SCM_DEFINE (scm_guardian_destroyed_p, "guardian-destroyed?", 1, 0, 0, SCM_DEFINE (scm_guardian_greedy_p, "guardian-greedy?", 1, 0, 0, (SCM guardian), - "Return @code{#t} if @var{guardian} is a greedy guardian, otherwise @code{#f}.\n") + "Return @code{#t} if @var{guardian} is a greedy guardian, otherwise @code{#f}.") #define FUNC_NAME s_scm_guardian_greedy_p { return SCM_BOOL (GREEDY_P (GUARDIAN_DATA (guardian))); diff --git a/libguile/hashtab.c b/libguile/hashtab.c index dc5545390..4cf250fae 100644 --- a/libguile/hashtab.c +++ b/libguile/hashtab.c @@ -525,7 +525,7 @@ SCM_DEFINE (scm_hash_fold, "hash-fold", 3, 0, 0, "prior-result is either INIT (for the first application of PROC)\n" "or the return value of the previous application of PROC.\n" "For example, @code{(hash-fold acons () tab)} will convert a hash\n" - "table into an a-list of key-value pairs.\n") + "table into an a-list of key-value pairs.") #define FUNC_NAME s_scm_hash_fold { SCM_VALIDATE_PROC (1,proc); diff --git a/libguile/modules.c b/libguile/modules.c index 1c458683e..f304df3df 100644 --- a/libguile/modules.c +++ b/libguile/modules.c @@ -77,7 +77,7 @@ static void scm_post_boot_init_modules (void); SCM_DEFINE (scm_set_current_module, "set-current-module", 1, 0, 0, (SCM module), - "Set the current module to @var{module} and return" + "Set the current module to @var{module} and return\n" "the previous current module.") #define FUNC_NAME s_scm_set_current_module { diff --git a/libguile/ports.c b/libguile/ports.c index 7a02b1308..0250f503c 100644 --- a/libguile/ports.c +++ b/libguile/ports.c @@ -364,7 +364,7 @@ SCM_DEFINE (scm_current_input_port, "current-input-port", 0, 0, 0, SCM_DEFINE (scm_current_output_port, "current-output-port", 0, 0, 0, (), "Return the current output port. This is the default port used\n" - "by many output procedures. Initially, \n" + "by many output procedures. Initially,\n" "@code{current-output-port} returns the @dfn{standard output} in\n" "Unix and C terminology.") #define FUNC_NAME s_scm_current_output_port @@ -724,7 +724,7 @@ SCM_DEFINE (scm_port_for_each, "port-for-each", 1, 0, 0, "@var{proc} is applied exactly once to every port that exists\n" "in the system at the time @var{port-for-each} is invoked.\n" "Changes to the port table while @var{port-for-each} is running\n" - "have no effect as far as @var{port-for-each} is concerned.\n") + "have no effect as far as @var{port-for-each} is concerned.") #define FUNC_NAME s_scm_port_for_each { long i; @@ -819,7 +819,7 @@ SCM_DEFINE (scm_eof_object_p, "eof-object?", 1, 0, 0, SCM_DEFINE (scm_force_output, "force-output", 0, 1, 0, (SCM port), "Flush the specified output port, or the current output port if @var{port}\n" - "is omitted. The current output buffer contents are passed to the \n" + "is omitted. The current output buffer contents are passed to the\n" "underlying port implementation (e.g., in the case of fports, the\n" "data will be written to the file and the output buffer will be cleared.)\n" "It has no effect on an unbuffered port.\n\n" diff --git a/libguile/posix.c b/libguile/posix.c index 033678947..acec88b08 100644 --- a/libguile/posix.c +++ b/libguile/posix.c @@ -1328,7 +1328,7 @@ SCM_DEFINE (scm_sync, "sync", 0, 0, 0, SCM_DEFINE (scm_crypt, "crypt", 2, 0, 0, (SCM key, SCM salt), "Encrypt @var{key} using @var{salt} as the salt value to the\n" - "crypt(3) library call\n") + "crypt(3) library call.") #define FUNC_NAME s_scm_crypt { char * p; diff --git a/libguile/random.c b/libguile/random.c index 4883ff16f..ba64d1ab2 100644 --- a/libguile/random.c +++ b/libguile/random.c @@ -364,9 +364,9 @@ SCM_DEFINE (scm_random, "random", 1, 1, 0, (SCM n, SCM state), "Return a number in [0,N).\n" "\n" - "Accepts a positive integer or real n and returns a \n" - "number of the same type between zero (inclusive) and \n" - "N (exclusive). The values returned have a uniform \n" + "Accepts a positive integer or real n and returns a\n" + "number of the same type between zero (inclusive) and\n" + "N (exclusive). The values returned have a uniform\n" "distribution.\n" "\n" "The optional argument @var{state} must be of the type produced\n" @@ -490,8 +490,8 @@ SCM_DEFINE (scm_random_solid_sphere_x, "random:solid-sphere!", 1, 1, 0, (SCM v, SCM state), "Fills vect with inexact real random numbers\n" "the sum of whose squares is less than 1.0.\n" - "Thinking of vect as coordinates in space of \n" - "dimension n = (vector-length vect), the coordinates \n" + "Thinking of vect as coordinates in space of\n" + "dimension n = (vector-length vect), the coordinates\n" "are uniformly distributed within the unit n-shere.\n" "The sum of the squares of the numbers is returned.") #define FUNC_NAME s_scm_random_solid_sphere_x @@ -513,9 +513,9 @@ SCM_DEFINE (scm_random_hollow_sphere_x, "random:hollow-sphere!", 1, 1, 0, (SCM v, SCM state), "Fills vect with inexact real random numbers\n" "the sum of whose squares is equal to 1.0.\n" - "Thinking of vect as coordinates in space of \n" + "Thinking of vect as coordinates in space of\n" "dimension n = (vector-length vect), the coordinates\n" - "are uniformly distributed over the surface of the \n" + "are uniformly distributed over the surface of the\n" "unit n-shere.") #define FUNC_NAME s_scm_random_hollow_sphere_x { diff --git a/libguile/scmsigs.c b/libguile/scmsigs.c index 55439f2e5..5ee384995 100644 --- a/libguile/scmsigs.c +++ b/libguile/scmsigs.c @@ -434,13 +434,13 @@ SCM_DEFINE (scm_setitimer, "setitimer", 5, 0, 0, "Errors are handled as described in the guile info pages under ``POSIX\n" "Interface Conventions''.\n" "\n" - "The timers available are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL}, \n" + "The timers available are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL},\n" "and @code{ITIMER_PROF}.\n" "\n" "The return value will be a list of two cons pairs representing the\n" "current state of the given timer. The first pair is the seconds and\n" "microseconds of the timer @code{it_interval}, and the second pair is\n" - "the seconds and microseconds of the timer @code{it_value}.\n") + "the seconds and microseconds of the timer @code{it_value}.") #define FUNC_NAME s_scm_setitimer { int rv; @@ -475,13 +475,13 @@ SCM_DEFINE (scm_getitimer, "getitimer", 1, 0, 0, "Errors are handled as described in the guile info pages under ``POSIX\n" "Interface Conventions''.\n" "\n" - "The timers available are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL}, \n" + "The timers available are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL},\n" "and @code{ITIMER_PROF}.\n" "\n" "The return value will be a list of two cons pairs representing the\n" "current state of the given timer. The first pair is the seconds and\n" "microseconds of the timer @code{it_interval}, and the second pair is\n" - "the seconds and microseconds of the timer @code{it_value}.\n") + "the seconds and microseconds of the timer @code{it_value}.") #define FUNC_NAME s_scm_getitimer { int rv; diff --git a/libguile/strings.c b/libguile/strings.c index 41cb50005..eef9f4a7f 100644 --- a/libguile/strings.c +++ b/libguile/strings.c @@ -211,7 +211,7 @@ SCM_DEFINE (scm_make_string, "make-string", 1, 1, 0, "Return a newly allocated string of\n" "length @var{k}. If @var{chr} is given, then all elements of\n" "the string are initialized to @var{chr}, otherwise the contents\n" - "of the @var{string} are unspecified.\n") + "of the @var{string} are unspecified.") #define FUNC_NAME s_scm_make_string { if (SCM_INUMP (k)) diff --git a/libguile/strop.c b/libguile/strop.c index a173cacea..9369c3ec8 100644 --- a/libguile/strop.c +++ b/libguile/strop.c @@ -64,7 +64,7 @@ If you do not wish that, delete this exception notice. */ /* xSCM_DEFINE (scm_i_index, "i-index", 2, 2, 0, (SCM str, SCM chr, SCM frm, SCM to), - "@deftypefn {Internal C Function} {static int} scm_i_index (SCM *@var{str}, \n" + "@deftypefn {Internal C Function} {static int} scm_i_index (SCM *@var{str},\n" "SCM @var{chr}, int @var{direction}, SCM @var{sub_start}, SCM @var{sub_end}, char *@var{why}) "This is a workhorse function that performs either an @code{index} or\n" "@code{rindex} function, depending on the value of @var{direction}." diff --git a/libguile/struct.c b/libguile/struct.c index 27eecebe4..f24fefdb2 100644 --- a/libguile/struct.c +++ b/libguile/struct.c @@ -72,7 +72,7 @@ SCM_DEFINE (scm_make_struct_layout, "make-struct-layout", 1, 0, 0, "type, the second a field protection. Allowed types are 'p' for\n" "GC-protected Scheme data, 'u' for unprotected binary data, and 's' for\n" "a field that points to the structure itself. Allowed protections\n" - "are 'w' for mutable fields, 'r' for read-only fields, and 'o' for opaque \n" + "are 'w' for mutable fields, 'r' for read-only fields, and 'o' for opaque\n" "fields. The last field protection specification may be capitalized to\n" "indicate that the field is a tail-array.") #define FUNC_NAME s_scm_make_struct_layout @@ -521,7 +521,7 @@ SCM_DEFINE (scm_make_vtable_vtable, "make-vtable-vtable", 2, 0, 1, "(define (make-ball type owner) (make-struct type 0 owner))\n\n" "(define ball (make-ball green 'Nisse))\n" "ball @result{} #<a green ball owned by Nisse>\n" - "@end lisp\n") + "@end lisp") #define FUNC_NAME s_scm_make_vtable_vtable { SCM fields; diff --git a/libguile/unif.c b/libguile/unif.c index 392e376b2..138fe36a8 100644 --- a/libguile/unif.c +++ b/libguile/unif.c @@ -1656,7 +1656,7 @@ SCM_DEFINE (scm_uniform_array_write, "uniform-array-write", 1, 3, 0, "The optional arguments @var{start}\n" "and @var{end} allow\n" "a specified region of a vector (or linearized array) to be written.\n\n" - "The number of objects actually written is returned. \n" + "The number of objects actually written is returned.\n" "@var{port-or-fdes} may be\n" "omitted, in which case it defaults to the value returned by\n" "@code{(current-output-port)}.") diff --git a/libguile/variable.c b/libguile/variable.c index 7a4763b00..b0e9b61d9 100644 --- a/libguile/variable.c +++ b/libguile/variable.c @@ -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); |