This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document WIDEST_UTYPE
authorKarl Williamson <khw@cpan.org>
Fri, 30 Aug 2019 20:08:13 +0000 (14:08 -0600)
committerKarl Williamson <khw@cpan.org>
Tue, 3 Sep 2019 03:52:11 +0000 (21:52 -0600)
handy.h

diff --git a/handy.h b/handy.h
index 8914909..d180f2b 100644 (file)
--- a/handy.h
+++ b/handy.h
@@ -1267,7 +1267,22 @@ patched there.  The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
 
 */
 
-/* Specify the widest unsigned type on the platform. */
+/*
+   void below because that's the best fit, and works for Devel::PPPort
+=for apidoc AmnU|void|WIDEST_UTYPE
+
+Yields the widest unsigned integer type on the platform, currently either
+C<U32> or C<64>.  This can be used in declarations such as
+
+ WIDEST_UTYPE my_uv;
+
+or casts
+
+ my_uv = (WIDEST_UTYPE) val;
+
+=cut
+
+*/
 #ifdef QUADKIND
 #   define WIDEST_UTYPE U64
 #else