diff options
author | Karl Williamson <khw@cpan.org> | 2020-08-16 06:31:31 -0600 |
---|---|---|
committer | Karl Williamson <khw@cpan.org> | 2020-09-04 16:54:58 -0600 |
commit | 0afc88d2cf06c423122bf95d61d95a64fb207815 (patch) | |
tree | ceb804fde570581d9a1630a2be9151f01059abd7 /warnings.h | |
parent | 90d2107837a3c1721e357b4272a34a623ff141ac (diff) | |
download | perl-0afc88d2cf06c423122bf95d61d95a64fb207815.tar.gz |
regen/warnings.pl: Collapse closely related pod
Having separate entries for ckWARN ... ckWARN4 just clutters things
up. Instead fairly recent extensions to our API generation mechanism
allows these to be variants in a single entry.
Diffstat (limited to 'warnings.h')
-rw-r--r-- | warnings.h | 56 |
1 files changed, 14 insertions, 42 deletions
diff --git a/warnings.h b/warnings.h index f02edea0fa..804743cf19 100644 --- a/warnings.h +++ b/warnings.h @@ -242,54 +242,26 @@ perl program becomes C<WARN_VOID> when used in XS code and passed to one of the calls below. =for apidoc Am|bool|ckWARN|U32 w +=for apidoc_item ||ckWARN2|U32 w1|U32 w2 +=for apidoc_item ||ckWARN3|U32 w1|U32 w2|U32 w3 +=for apidoc_item ||ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4 +These return a boolean as to whether or not warnings are enabled for any of +the warning category(ies) parameters: C<w>, C<w1>, .... -Returns a boolean as to whether or not warnings are enabled for the warning -category C<w>. If the category is by default enabled even if not within the -scope of S<C<use warnings>>, instead use the L</ckWARN_d> macro. +Should any of the categories by default be enabled even if not within the +scope of S<C<use warnings>>, instead use the C<L</ckWARN_d>> macros. -=for apidoc Am|bool|ckWARN_d|U32 w - -Like C<L</ckWARN>>, but for use if and only if the warning category is by -default enabled even if not within the scope of S<C<use warnings>>. - -=for apidoc Am|bool|ckWARN2|U32 w1|U32 w2 +The categories must be completely independent, one may not be subclassed from +the other. -Like C<L</ckWARN>>, but takes two warnings categories as input, and returns -TRUE if either is enabled. If either category is by default enabled even if -not within the scope of S<C<use warnings>>, instead use the L</ckWARN2_d> -macro. The categories must be completely independent, one may not be -subclassed from the other. - -=for apidoc Am|bool|ckWARN2_d|U32 w1|U32 w2 +=for apidoc Am|bool|ckWARN_d|U32 w +=for apidoc_item ckWARN2_d|U32 w1|U32 w2 +=for apidoc_item ckWARN3_d|U32 w1|U32 w2|U32 w3 +=for apidoc_item ckWARN4_d|U32 w1|U32 w2|U32 w3|U32 w4 -Like C<L</ckWARN2>>, but for use if and only if either warning category is by +Like C<L</ckWARN>>, but for use if and only if the warning category(ies) is by default enabled even if not within the scope of S<C<use warnings>>. -=for apidoc Am|bool|ckWARN3|U32 w1|U32 w2|U32 w3 - -Like C<L</ckWARN2>>, but takes three warnings categories as input, and returns -TRUE if any is enabled. If any of the categories is by default enabled even -if not within the scope of S<C<use warnings>>, instead use the L</ckWARN3_d> -macro. The categories must be completely independent, one may not be -subclassed from any other. - -=for apidoc Am|bool|ckWARN3_d|U32 w1|U32 w2|U32 w3 - -Like C<L</ckWARN3>>, but for use if and only if any of the warning categories -is by default enabled even if not within the scope of S<C<use warnings>>. - -=for apidoc Am|bool|ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4 - -Like C<L</ckWARN3>>, but takes four warnings categories as input, and returns -TRUE if any is enabled. If any of the categories is by default enabled even -if not within the scope of S<C<use warnings>>, instead use the L</ckWARN4_d> -macro. The categories must be completely independent, one may not be -subclassed from any other. - -=for apidoc Am|bool|ckWARN4_d|U32 w1|U32 w2|U32 w3|U32 w4 - -Like C<L</ckWARN4>>, but for use if and only if any of the warning categories -is by default enabled even if not within the scope of S<C<use warnings>>. =cut |