diff options
| -rw-r--r-- | regen/warnings.pl | 7 | ||||
| -rw-r--r-- | warnings.h | 7 |
2 files changed, 14 insertions, 0 deletions
diff --git a/regen/warnings.pl b/regen/warnings.pl index d761e5d3d2..56186c5fa0 100644 --- a/regen/warnings.pl +++ b/regen/warnings.pl @@ -388,6 +388,13 @@ EOM =head1 Warning and Dieing +In all these calls, the C<U32 wI<n>> parameters are warning category +constants. You can see the ones currently available in +L<warnings/Category Hierarchy>, just capitalize all letters in the names +and prefix them by C<WARN_>. So, for example, the category C<void> used in a +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 Returns a boolean as to whether or not warnings are enabled for the warning diff --git a/warnings.h b/warnings.h index 6f0bf6b485..c94494f8f4 100644 --- a/warnings.h +++ b/warnings.h @@ -145,6 +145,13 @@ =head1 Warning and Dieing +In all these calls, the C<U32 wI<n>> parameters are warning category +constants. You can see the ones currently available in +L<warnings/Category Hierarchy>, just capitalize all letters in the names +and prefix them by C<WARN_>. So, for example, the category C<void> used in a +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 Returns a boolean as to whether or not warnings are enabled for the warning |