summaryrefslogtreecommitdiff
path: root/perl.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-10-17 15:37:18 -0600
committerKarl Williamson <khw@cpan.org>2020-11-02 09:18:05 -0700
commit83dc55ab314ff72b853c420a31497f5ff529c950 (patch)
tree575a45c27dee53063b0b7c2f95e39f34b146b322 /perl.h
parent25adf908beda7dc3c792f06819467997db298ed9 (diff)
downloadperl-83dc55ab314ff72b853c420a31497f5ff529c950.tar.gz
perlapi: Document IV_MAX, UV_MAX
Diffstat (limited to 'perl.h')
-rw-r--r--perl.h19
1 files changed, 19 insertions, 0 deletions
diff --git a/perl.h b/perl.h
index c8316361de..343d8deaa3 100644
--- 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