From 4a2d84b3dcfed6226b95c4cc32dd3d58bc848868 Mon Sep 17 00:00:00 2001 From: Kaz Kylheku Date: Tue, 14 Jan 2014 07:22:41 -0800 Subject: * txr.1: Wrote missing documentation for throw, throwf and error. --- ChangeLog | 4 ++++ txr.1 | 23 +++++++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/ChangeLog b/ChangeLog index ecdf8971..fe500cfe 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2014-01-14 Kaz Kylheku + + * txr.1: Wrote missing documentation for throw, throwf and error. + 2014-01-14 Kaz Kylheku * stream.c (stdio_seek): After a successful seek, discard the character diff --git a/txr.1 b/txr.1 index 1e7e5bb5..df8ef0dd 100644 --- a/txr.1 +++ b/txr.1 @@ -9377,6 +9377,29 @@ In other words, the following equivalences hold: .SS Functions throw, throwf and error +.TP +Syntax: + + (throw . ) + (throwf . ) + (error . ) + +.TP +Description: + +These functions generate an exception. The throw and throwf functions generate +an exception identified by , whereas error throws an exception of +type error. The call (error ...) can be regarded as a shorthand for +(throwf 'error ...). + +The throw function takes zero or more additional arguments. These arguments +become the arguments of a catch handler which takes the exception. The +handler will have to be capable of accepting that number of arguments. + +The throwf and error functions generate an exception which has a single +argument: a character string created by a formatted print to a string stream +using the format string and additional arguments. + .SS Operator catch .TP -- cgit v1.2.3