mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-18 17:50:29 +02:00
Code Activity

Correct, update, improve and clean up a lot of docstrings in order to make

Browse source 
the documentation much more consistent.
This commit is contained in:
Martin Grabmüller 2001-04-03 13:19:05 +00:00
parent ae9f3a1582
commit 1e6808ea20
41 changed files with 1133 additions and 949 deletions
Download patch file Download diff file Expand all files Collapse all files

31
libguile/error.c
View file

@ -98,18 +98,20 @@ scm_error (SCM key, const char *subr, const char *message, SCM args, SCM rest)
/* Scheme interface to scm_error. */
SCM_DEFINE (scm_error_scm, "scm-error", 5, 0, 0,
(SCM key, SCM subr, SCM message, SCM args, SCM rest),
"Raise an error with key @var{key}. @var{subr} can be a string naming\n"
"the procedure associated with the error, or @code{#f}. @var{message}\n"
"is the error message string, possibly containing @code{~S} and @code{~A}\n"
"escapes. When an error is reported, these are replaced by formating the\n"
"corresponding members of @var{args}: @code{~A} (was @code{%s}) formats using @code{display}\n"
"and @code{~S} (was @code{%S}) formats using @code{write}. @var{data} is a\n"
"list or @code{#f} depending on @var{key}: if @var{key} is\n"
"@code{system-error} then it should be a list\n"
"containing the Unix @code{errno} value; If @var{key} is @code{signal} then\n"
"it should be a list containing the Unix signal number; otherwise it\n"
"will usually be @code{#f}.")
(SCM key, SCM subr, SCM message, SCM args, SCM data),
"Raise an error with key @var{key}. @var{subr} can be a string\n"
"naming the procedure associated with the error, or @code{#f}.\n"
"@var{message} is the error message string, possibly containing\n"
"@code{~S} and @code{~A} escapes. When an error is reported,\n"
"these are replaced by formatting the corresponding members of\n"
"@var{args}: @code{~A} (was @code{%s} in older versions of\n"
"Guile) formats using @code{display} and @code{~S} (was\n"
"@code{%S}) formats using @code{write}. @var{data} is a list or\n"
"@code{#f} depending on @var{key}: if @var{key} is\n"
"@code{system-error} then it should be a list containing the\n"
"Unix @code{errno} value; If @var{key} is @code{signal} then it\n"
"should be a list containing the Unix signal number; otherwise\n"
"it will usually be @code{#f}.")
#define FUNC_NAME s_scm_error_scm
{
char *szSubr;
@ -143,14 +145,15 @@ SCM_DEFINE (scm_error_scm, "scm-error", 5, 0, 0,
szMessage = SCM_STRING_CHARS (message);
}
scm_error (key, szSubr, szMessage, args, rest);
scm_error (key, szSubr, szMessage, args, data);
/* not reached. */
}
#undef FUNC_NAME
SCM_DEFINE (scm_strerror, "strerror", 1, 0, 0,
(SCM err),
"Returns the Unix error message corresponding to @var{err}, an integer.")
"Return the Unix error message corresponding to @var{err}, which\n"
"must be an integer value.")
#define FUNC_NAME s_scm_strerror
{
SCM_VALIDATE_INUM (1,err);