summaryrefslogtreecommitdiff
path: root/util.c
diff options
context:
space:
mode:
authorMark Fowler <mark@twoshortplanks.com>2004-02-25 22:47:21 +0000
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>2004-02-26 13:03:43 +0000
commit966353fd3bdcf950fb1b25211b8347d7475c08f0 (patch)
treea9ea0fba11a13cbc3aa0d4deb266c02998cdc7ad /util.c
parent91fc0aa523010b5e70767eabb90b518ed6cc21ae (diff)
downloadperl-966353fd3bdcf950fb1b25211b8347d7475c08f0.tar.gz
Improved perlapi documentation for croak
Message-ID: <Pine.LNX.4.55.0402252242510.32152@gan.twoshortplanks.com> (and regenerate perlapi.pod.) p4raw-id: //depot/perl@22380
Diffstat (limited to 'util.c')
-rw-r--r--util.c10
1 files changed, 5 insertions, 5 deletions
diff --git a/util.c b/util.c
index 0927477432..d25b791aab 100644
--- a/util.c
+++ b/util.c
@@ -1224,8 +1224,9 @@ Perl_croak_nocontext(const char *pat, ...)
=for apidoc croak
This is the XSUB-writer's interface to Perl's C<die> function.
-Normally use this function the same way you use the C C<printf>
-function. See C<warn>.
+Normally call this function the same way you call the C C<printf>
+function. Calling C<croak> returns control directly to Perl,
+sidestepping the normal C order of execution. See C<warn>.
If you want to throw an exception object, assign the object to
C<$@> and then pass C<Nullch> to croak():
@@ -1310,9 +1311,8 @@ Perl_warn_nocontext(const char *pat, ...)
/*
=for apidoc warn
-This is the XSUB-writer's interface to Perl's C<warn> function. Use this
-function the same way you use the C C<printf> function. See
-C<croak>.
+This is the XSUB-writer's interface to Perl's C<warn> function. Call this
+function the same way you call the C C<printf> function. See C<croak>.
=cut
*/