This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add details to pod for foo(MAX|INT)_C entries
authorKarl Williamson <khw@cpan.org>
Wed, 7 Oct 2020 04:09:19 +0000 (22:09 -0600)
committerKarl Williamson <khw@cpan.org>
Thu, 8 Oct 2020 14:23:29 +0000 (08:23 -0600)
perl.h

diff --git a/perl.h b/perl.h
index a5cb430..e663311 100644 (file)
--- a/perl.h
+++ b/perl.h
@@ -1056,6 +1056,7 @@ Returns a token the C compiler recognizes for the constant C<number> of the
 corresponding integer type on the machine.
 
 If the machine does not have a 64-bit type, C<INT64_C> is undefined.
+Use C<L</INTMAX_C>> to get the largest type available on the platform.
 
 =for apidoc    Am|U16|UINT16_C|number
 =for apidoc_item |U32|UINT32_C|number
@@ -1065,6 +1066,7 @@ Returns a token the C compiler recognizes for the constant C<number> of the
 corresponding unsigned integer type on the machine.
 
 If the machine does not have a 64-bit type, C<UINT64_C> is undefined.
+Use C<L</UINTMAX_C>> to get the largest type available on the platform.
 
 
 =cut
@@ -1143,6 +1145,10 @@ long>s, C<INTMAX_C(-1)> would yield
 
  -1LL
 
+See also, for example, C<L</INT32_C>>.
+
+Use L</IV> to declare variables of the maximum usable size on this platform.
+
 =for apidoc Am||UINTMAX_C|number
 Returns a token the C compiler recognizes for the constant C<number> of the
 widest unsigned integer type on the machine.  For example, if the machine has
@@ -1150,6 +1156,10 @@ C<long>s, C<UINTMAX_C(1)> would yield
 
  1UL
 
+See also, for example, C<L</UINT32_C>>.
+
+Use L</UV> to declare variables of the maximum usable size on this platform.
+
 =cut
 */