diff options
| author | Karl Williamson <khw@cpan.org> | 2019-08-29 16:52:45 -0600 |
|---|---|---|
| committer | Karl Williamson <khw@cpan.org> | 2019-09-02 21:52:10 -0600 |
| commit | bb3eff5d3d7e45d422801f5cc0f329daf0c4766d (patch) | |
| tree | f03e4d09e197cfffa3180205d5ccf011e382f07b /warnings.h | |
| parent | 91bad5a4f7b0ea7217f0f1fc7cdfa5ede59c1b50 (diff) | |
| download | perl-bb3eff5d3d7e45d422801f5cc0f329daf0c4766d.tar.gz | |
warnings.h: Add pod about finding the XS warning category
The XS category names are easily derivable from the chart of perl-space
categories.
Diffstat (limited to 'warnings.h')
| -rw-r--r-- | warnings.h | 7 |
1 files changed, 7 insertions, 0 deletions
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 |