1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-06 15:40:29 +02:00

* Cosmetic docstring fixes.

This commit is contained in:
Neil Jerram 2000-09-29 20:22:31 +00:00
parent bbe4e612aa
commit 6ec589e2a2
4 changed files with 30 additions and 16 deletions

View file

@ -1,3 +1,16 @@
2000-09-29 Neil Jerram <neil@ossau.uklinux.net>
* net_db.c (scm_inet_ntoa): Docstring fix: missing newline
inserted.
* hashtab.c (scm_hashx_create_handle_x, scm_hashx_ref): Insert
spaces between C parameters so that the snarfer doesn't coalesce
them all into a single very long-named parameter.
2000-09-27 Neil Jerram <neil@ossau.uklinux.net>
* list.c (scm_append): Use @example texinfo markup in docstring.
2000-09-26 Dirk Herrmann <D.Herrmann@tu-bs.de> 2000-09-26 Dirk Herrmann <D.Herrmann@tu-bs.de>
* strings.c (scm_string, scm_make_string, scm_string_set_x, * strings.c (scm_string, scm_make_string, scm_string_set_x,

View file

@ -433,7 +433,7 @@ SCM_DEFINE (scm_hashx_get_handle, "hashx-get-handle", 4, 0, 0,
SCM_DEFINE (scm_hashx_create_handle_x, "hashx-create-handle!", 5, 0, 0, SCM_DEFINE (scm_hashx_create_handle_x, "hashx-create-handle!", 5, 0, 0,
(SCM hash,SCM assoc,SCM table,SCM obj,SCM init), (SCM hash, SCM assoc, SCM table, SCM obj, SCM init),
"This behaves the same way as the corresponding @code{-create-handle}\n" "This behaves the same way as the corresponding @code{-create-handle}\n"
"function, but uses @var{hasher} as a\n" "function, but uses @var{hasher} as a\n"
"hash function and @var{assoc} to compare keys. @code{hasher} must\n" "hash function and @var{assoc} to compare keys. @code{hasher} must\n"
@ -452,7 +452,7 @@ SCM_DEFINE (scm_hashx_create_handle_x, "hashx-create-handle!", 5, 0, 0,
SCM_DEFINE (scm_hashx_ref, "hashx-ref", 4, 1, 0, SCM_DEFINE (scm_hashx_ref, "hashx-ref", 4, 1, 0,
(SCM hash,SCM assoc,SCM table,SCM obj,SCM dflt), (SCM hash, SCM assoc, SCM table, SCM obj, SCM dflt),
"This behaves the same way as the corresponding @code{ref}\n" "This behaves the same way as the corresponding @code{ref}\n"
"function, but uses @var{hasher} as a\n" "function, but uses @var{hasher} as a\n"
"hash function and @var{assoc} to compare keys. @code{hasher} must\n" "hash function and @var{assoc} to compare keys. @code{hasher} must\n"

View file

@ -192,19 +192,20 @@ SCM_DEFINE (scm_length, "length", 1, 0, 0,
SCM_DEFINE (scm_append, "append", 0, 0, 1, SCM_DEFINE (scm_append, "append", 0, 0, 1,
(SCM args), (SCM args),
"Returns a list consisting of the elements of the first LIST\n" "Returns a list consisting of the elements of the first LIST\n"
"followed by the elements of the other LISTs.\n" "followed by the elements of the other LISTs.\n\n"
"\n" "@example\n"
" (append '(x) '(y)) => (x y)\n" " (append '(x) '(y)) => (x y)\n"
" (append '(a) '(b c d)) => (a b c d)\n" " (append '(a) '(b c d)) => (a b c d)\n"
" (append '(a (b)) '((c))) => (a (b) (c))\n" " (append '(a (b)) '((c))) => (a (b) (c))\n"
"\n" "@end example\n\n"
"The resulting list is always newly allocated, except that it shares\n" "The resulting list is always newly allocated, except that it shares\n"
"structure with the last LIST argument. The last argument may\n" "structure with the last LIST argument. The last argument may\n"
"actually be any object; an improper list results if the last\n" "actually be any object; an improper list results if the last\n"
"argument is not a proper list.\n" "argument is not a proper list.\n\n"
"@example\n"
" (append '(a b) '(c . d)) => (a b c . d)\n" " (append '(a b) '(c . d)) => (a b c . d)\n"
" (append '() 'a) => a\n") " (append '() 'a) => a\n"
"@end example")
#define FUNC_NAME s_scm_append #define FUNC_NAME s_scm_append
{ {
SCM_VALIDATE_REST_ARGUMENT (args); SCM_VALIDATE_REST_ARGUMENT (args);

View file

@ -108,7 +108,7 @@ SCM_DEFINE (scm_inet_ntoa, "inet-ntoa", 1, 0, 0,
"Converts an integer Internet host address into a string with the\n" "Converts an integer Internet host address into a string with the\n"
"traditional dotted decimal representation.\n\n" "traditional dotted decimal representation.\n\n"
"@smalllisp\n" "@smalllisp\n"
"(inet-ntoa 2130706433) @result{} \"127.0.0.1\"" "(inet-ntoa 2130706433) @result{} \"127.0.0.1\"\n"
"@end smalllisp") "@end smalllisp")
#define FUNC_NAME s_scm_inet_ntoa #define FUNC_NAME s_scm_inet_ntoa
{ {