This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Document cBOOL
authorKarl Williamson <khw@cpan.org>
Mon, 5 Aug 2019 00:22:16 +0000 (18:22 -0600)
committerKarl Williamson <khw@cpan.org>
Tue, 3 Sep 2019 03:52:10 +0000 (21:52 -0600)
handy.h

diff --git a/handy.h b/handy.h
index 0170773..855c232 100644 (file)
--- a/handy.h
+++ b/handy.h
@@ -97,10 +97,17 @@ Null SV pointer.  (No longer available when C<PERL_CORE> is defined.)
 # define HAS_BOOL 1
 #endif
 
-/* cast-to-bool.  A simple (bool) cast may not do the right thing: if bool is
- * defined as char for example, then the cast from int is
- * implementation-defined (bool)!!(cbool) in a ternary triggers a bug in xlc on
- * AIX */
+/*
+=for apidoc Am|bool|cBOOL|bool expr
+
+Cast-to-bool.  A simple S<C<(bool) I<expr>>> cast may not do the right thing:
+if C<bool> is defined as C<char>, for example, then the cast from C<int> is
+implementation-defined.
+
+C<(bool)!!(cbool)> in a ternary triggers a bug in xlc on AIX
+
+=cut
+*/
 #define cBOOL(cbool) ((cbool) ? (bool)1 : (bool)0)
 
 /* Try to figure out __func__ or __FUNCTION__ equivalent, if any.