summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-08-16 06:32:41 -0600
committerKarl Williamson <khw@cpan.org>2020-09-04 16:54:58 -0600
commitb8a2649a502a2760c6bc90d32f71a03c232eee81 (patch)
tree461e915185fcaba0da24339fae4558c45f7adbb8
parent0afc88d2cf06c423122bf95d61d95a64fb207815 (diff)
downloadperl-b8a2649a502a2760c6bc90d32f71a03c232eee81.tar.gz
Document packWARN.?
-rw-r--r--regen/warnings.pl15
-rw-r--r--warnings.h15
2 files changed, 24 insertions, 6 deletions
diff --git a/regen/warnings.pl b/regen/warnings.pl
index 58312ca806..f813d9360a 100644
--- a/regen/warnings.pl
+++ b/regen/warnings.pl
@@ -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
diff --git a/warnings.h b/warnings.h
index 804743cf19..0f7d7eb5c1 100644
--- a/warnings.h
+++ b/warnings.h
@@ -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