From b8a2649a502a2760c6bc90d32f71a03c232eee81 Mon Sep 17 00:00:00 2001 From: Karl Williamson Date: Sun, 16 Aug 2020 06:32:41 -0600 Subject: Document packWARN.? --- regen/warnings.pl | 15 ++++++++++++--- warnings.h | 15 ++++++++++++--- 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>, 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|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>, 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|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 -- cgit v1.2.1