This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Document IV_MAX, UV_MAX
authorKarl Williamson <khw@cpan.org>
Sat, 17 Oct 2020 21:37:18 +0000 (15:37 -0600)
committerKarl Williamson <khw@cpan.org>
Mon, 2 Nov 2020 16:18:05 +0000 (09:18 -0700)
perl.h

diff --git a/perl.h b/perl.h
index c831636..343d8de 100644 (file)
--- a/perl.h
+++ b/perl.h
@@ -4229,6 +4229,25 @@ Cast an NV to UV while avoiding undefined C behavior
 #define U_I(what) ((unsigned int)U_32(what))
 #define U_L(what) U_32(what)
 
+/*
+=for apidoc_section Integer configuration values
+=for apidoc Amn|IV|IV_MAX
+The largest signed integer that fits in an IV on this platform.
+
+=for apidoc Amn|IV|IV_MIN
+The negative signed integer furthest away from 0 that fits in an IV on this
+platform.
+
+=for apidoc Amn|UV|UV_MAX
+The largest unsigned integer that fits in a UV on this platform.
+
+=for apidoc Amn|UV|UV_MIN
+The smallest unsigned integer that fits in a UV on this platform.  It should
+equal zero.
+
+=cut
+*/
+
 #ifdef HAS_SIGNBIT
 #  ifndef Perl_signbit
 #    define Perl_signbit signbit