From 0afc88d2cf06c423122bf95d61d95a64fb207815 Mon Sep 17 00:00:00 2001 From: Karl Williamson Date: Sun, 16 Aug 2020 06:31:31 -0600 Subject: 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. --- warnings.h | 56 ++++++++++++++------------------------------------------ 1 file changed, 14 insertions(+), 42 deletions(-) (limited to 'warnings.h') 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 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, C, .... -Returns a boolean as to whether or not warnings are enabled for the warning -category C. If the category is by default enabled even if not within the -scope of S>, instead use the L macro. +Should any of the categories by default be enabled even if not within the +scope of S>, instead use the C> macros. -=for apidoc Am|bool|ckWARN_d|U32 w - -Like C>, but for use if and only if the warning category is by -default enabled even if not within the scope of S>. - -=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>, 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>, instead use the L -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>, but for use if and only if either warning category is by +Like C>, but for use if and only if the warning category(ies) is by default enabled even if not within the scope of S>. -=for apidoc Am|bool|ckWARN3|U32 w1|U32 w2|U32 w3 - -Like C>, 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>, instead use the L -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>, but for use if and only if any of the warning categories -is by default enabled even if not within the scope of S>. - -=for apidoc Am|bool|ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4 - -Like C>, 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>, instead use the L -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>, but for use if and only if any of the warning categories -is by default enabled even if not within the scope of S>. =cut -- cgit v1.2.1