summaryrefslogtreecommitdiff
path: root/libguile/error.c
diff options
context:
space:
mode:
authorMartin Grabmüller <mgrabmue@cs.tu-berlin.de>2001-04-03 13:19:05 +0000
committerMartin Grabmüller <mgrabmue@cs.tu-berlin.de>2001-04-03 13:19:05 +0000
commit1e6808ea204cef454e41af1e2f309100ab99e9e1 (patch)
treefb93c3098d7dd4e7af175dbde98b5dc41dcd7c0d /libguile/error.c
parentae9f3a15826847d280f69b179c2e09776892a9c6 (diff)
downloadguile-1e6808ea204cef454e41af1e2f309100ab99e9e1.tar.gz
Correct, update, improve and clean up a lot of docstrings in order to make
the documentation much more consistent.
Diffstat (limited to 'libguile/error.c')
-rw-r--r--libguile/error.c31
1 files changed, 17 insertions, 14 deletions
diff --git a/libguile/error.c b/libguile/error.c
index 9073e2afe..d8fcc7aa8 100644
--- a/libguile/error.c
+++ b/libguile/error.c
@@ -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);