This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document packWARN.?
authorKarl Williamson <khw@cpan.org>
Sun, 16 Aug 2020 12:32:41 +0000 (06:32 -0600)
committerKarl Williamson <khw@cpan.org>
Fri, 4 Sep 2020 22:54:58 +0000 (16:54 -0600)
regen/warnings.pl
warnings.h

index 58312ca..f813d93 100644 (file)
@@ -422,13 +422,22 @@ The categories must be completely independent, one may not be subclassed from
 the other.
 
 =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
+=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</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|U32|packWARN|U32 w1
+=for apidoc_item ||packWARN2|U32 w1|U32 w2
+=for apidoc_item ||packWARN3|U32 w1|U32 w2|U32 w3
+=for apidoc_item ||packWARN4|U32 w1|U32 w2|U32 w3|U32 w4
+
+These macros are used to pack warning categories into a single U32 to pass to
+macros and functions that take a warning category parameter.  The number of
+categories to pack is given by the name, with a corresponding number of
+category parameters passed.
 
 =cut
 
index 804743c..0f7d7eb 100644 (file)
@@ -255,13 +255,22 @@ The categories must be completely independent, one may not be subclassed from
 the other.
 
 =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
+=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</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|U32|packWARN|U32 w1
+=for apidoc_item ||packWARN2|U32 w1|U32 w2
+=for apidoc_item ||packWARN3|U32 w1|U32 w2|U32 w3
+=for apidoc_item ||packWARN4|U32 w1|U32 w2|U32 w3|U32 w4
+
+These macros are used to pack warning categories into a single U32 to pass to
+macros and functions that take a warning category parameter.  The number of
+categories to pack is given by the name, with a corresponding number of
+category parameters passed.
 
 =cut