perlapi: Display toFOO better

[perl5.git] / warnings.h

diff --git a/warnings.h b/warnings.h
index 804743c..f2008fe 100644 (file)
--- a/warnings.h
+++ b/warnings.h
@@ -130,87 +130,6 @@
 /* Warnings Categories added in Perl 5.031 */
 
 #define WARN_EXPERIMENTAL__ISA          73
-
-
-/*
-=for apidoc Amnh||WARN_ALL
-=for apidoc Amnh||WARN_CLOSURE
-=for apidoc Amnh||WARN_DEPRECATED
-=for apidoc Amnh||WARN_EXITING
-=for apidoc Amnh||WARN_GLOB
-=for apidoc Amnh||WARN_IO
-=for apidoc Amnh||WARN_CLOSED
-=for apidoc Amnh||WARN_EXEC
-=for apidoc Amnh||WARN_LAYER
-=for apidoc Amnh||WARN_NEWLINE
-=for apidoc Amnh||WARN_PIPE
-=for apidoc Amnh||WARN_UNOPENED
-=for apidoc Amnh||WARN_MISC
-=for apidoc Amnh||WARN_NUMERIC
-=for apidoc Amnh||WARN_ONCE
-=for apidoc Amnh||WARN_OVERFLOW
-=for apidoc Amnh||WARN_PACK
-=for apidoc Amnh||WARN_PORTABLE
-=for apidoc Amnh||WARN_RECURSION
-=for apidoc Amnh||WARN_REDEFINE
-=for apidoc Amnh||WARN_REGEXP
-=for apidoc Amnh||WARN_SEVERE
-=for apidoc Amnh||WARN_DEBUGGING
-=for apidoc Amnh||WARN_INPLACE
-=for apidoc Amnh||WARN_INTERNAL
-=for apidoc Amnh||WARN_MALLOC
-=for apidoc Amnh||WARN_SIGNAL
-=for apidoc Amnh||WARN_SUBSTR
-=for apidoc Amnh||WARN_SYNTAX
-=for apidoc Amnh||WARN_AMBIGUOUS
-=for apidoc Amnh||WARN_BAREWORD
-=for apidoc Amnh||WARN_DIGIT
-=for apidoc Amnh||WARN_PARENTHESIS
-=for apidoc Amnh||WARN_PRECEDENCE
-=for apidoc Amnh||WARN_PRINTF
-=for apidoc Amnh||WARN_PROTOTYPE
-=for apidoc Amnh||WARN_QW
-=for apidoc Amnh||WARN_RESERVED
-=for apidoc Amnh||WARN_SEMICOLON
-=for apidoc Amnh||WARN_TAINT
-=for apidoc Amnh||WARN_THREADS
-=for apidoc Amnh||WARN_UNINITIALIZED
-=for apidoc Amnh||WARN_UNPACK
-=for apidoc Amnh||WARN_UNTIE
-=for apidoc Amnh||WARN_UTF8
-=for apidoc Amnh||WARN_VOID
-=for apidoc Amnh||WARN_IMPRECISION
-=for apidoc Amnh||WARN_ILLEGALPROTO
-=for apidoc Amnh||WARN_NON_UNICODE
-=for apidoc Amnh||WARN_NONCHAR
-=for apidoc Amnh||WARN_SURROGATE
-=for apidoc Amnh||WARN_EXPERIMENTAL
-=for apidoc Amnh||WARN_EXPERIMENTAL__LEXICAL_SUBS
-=for apidoc Amnh||WARN_EXPERIMENTAL__REGEX_SETS
-=for apidoc Amnh||WARN_EXPERIMENTAL__SMARTMATCH
-=for apidoc Amnh||WARN_EXPERIMENTAL__POSTDEREF
-=for apidoc Amnh||WARN_EXPERIMENTAL__SIGNATURES
-=for apidoc Amnh||WARN_SYSCALLS
-=for apidoc Amnh||WARN_EXPERIMENTAL__BITWISE
-=for apidoc Amnh||WARN_EXPERIMENTAL__CONST_ATTR
-=for apidoc Amnh||WARN_EXPERIMENTAL__RE_STRICT
-=for apidoc Amnh||WARN_EXPERIMENTAL__REFALIASING
-=for apidoc Amnh||WARN_EXPERIMENTAL__WIN32_PERLIO
-=for apidoc Amnh||WARN_LOCALE
-=for apidoc Amnh||WARN_MISSING
-=for apidoc Amnh||WARN_REDUNDANT
-=for apidoc Amnh||WARN_EXPERIMENTAL__DECLARED_REFS
-=for apidoc Amnh||WARN_EXPERIMENTAL__ALPHA_ASSERTIONS
-=for apidoc Amnh||WARN_EXPERIMENTAL__SCRIPT_RUN
-=for apidoc Amnh||WARN_SHADOW
-=for apidoc Amnh||WARN_EXPERIMENTAL__PRIVATE_USE
-=for apidoc Amnh||WARN_EXPERIMENTAL__UNIPROP_WILDCARDS
-=for apidoc Amnh||WARN_EXPERIMENTAL__VLB
-=for apidoc Amnh||WARN_EXPERIMENTAL__ISA
-
-=cut
-*/
-
 #define WARNsize                        19
 #define WARN_ALLstring                  "\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125"
 #define WARN_NONEstring                         "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
@@ -255,13 +174,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
 
@@ -308,6 +236,87 @@ default enabled even if not within the scope of S<C<use warnings>>.
              (unpackWARN4(x) &&                                        \
                isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))))))))
 
+
+
+/*
+=for apidoc Amnh||WARN_ALL
+=for apidoc Amnh||WARN_CLOSURE
+=for apidoc Amnh||WARN_DEPRECATED
+=for apidoc Amnh||WARN_EXITING
+=for apidoc Amnh||WARN_GLOB
+=for apidoc Amnh||WARN_IO
+=for apidoc Amnh||WARN_CLOSED
+=for apidoc Amnh||WARN_EXEC
+=for apidoc Amnh||WARN_LAYER
+=for apidoc Amnh||WARN_NEWLINE
+=for apidoc Amnh||WARN_PIPE
+=for apidoc Amnh||WARN_UNOPENED
+=for apidoc Amnh||WARN_MISC
+=for apidoc Amnh||WARN_NUMERIC
+=for apidoc Amnh||WARN_ONCE
+=for apidoc Amnh||WARN_OVERFLOW
+=for apidoc Amnh||WARN_PACK
+=for apidoc Amnh||WARN_PORTABLE
+=for apidoc Amnh||WARN_RECURSION
+=for apidoc Amnh||WARN_REDEFINE
+=for apidoc Amnh||WARN_REGEXP
+=for apidoc Amnh||WARN_SEVERE
+=for apidoc Amnh||WARN_DEBUGGING
+=for apidoc Amnh||WARN_INPLACE
+=for apidoc Amnh||WARN_INTERNAL
+=for apidoc Amnh||WARN_MALLOC
+=for apidoc Amnh||WARN_SIGNAL
+=for apidoc Amnh||WARN_SUBSTR
+=for apidoc Amnh||WARN_SYNTAX
+=for apidoc Amnh||WARN_AMBIGUOUS
+=for apidoc Amnh||WARN_BAREWORD
+=for apidoc Amnh||WARN_DIGIT
+=for apidoc Amnh||WARN_PARENTHESIS
+=for apidoc Amnh||WARN_PRECEDENCE
+=for apidoc Amnh||WARN_PRINTF
+=for apidoc Amnh||WARN_PROTOTYPE
+=for apidoc Amnh||WARN_QW
+=for apidoc Amnh||WARN_RESERVED
+=for apidoc Amnh||WARN_SEMICOLON
+=for apidoc Amnh||WARN_TAINT
+=for apidoc Amnh||WARN_THREADS
+=for apidoc Amnh||WARN_UNINITIALIZED
+=for apidoc Amnh||WARN_UNPACK
+=for apidoc Amnh||WARN_UNTIE
+=for apidoc Amnh||WARN_UTF8
+=for apidoc Amnh||WARN_VOID
+=for apidoc Amnh||WARN_IMPRECISION
+=for apidoc Amnh||WARN_ILLEGALPROTO
+=for apidoc Amnh||WARN_NON_UNICODE
+=for apidoc Amnh||WARN_NONCHAR
+=for apidoc Amnh||WARN_SURROGATE
+=for apidoc Amnh||WARN_EXPERIMENTAL
+=for apidoc Amnh||WARN_EXPERIMENTAL__LEXICAL_SUBS
+=for apidoc Amnh||WARN_EXPERIMENTAL__REGEX_SETS
+=for apidoc Amnh||WARN_EXPERIMENTAL__SMARTMATCH
+=for apidoc Amnh||WARN_EXPERIMENTAL__POSTDEREF
+=for apidoc Amnh||WARN_EXPERIMENTAL__SIGNATURES
+=for apidoc Amnh||WARN_SYSCALLS
+=for apidoc Amnh||WARN_EXPERIMENTAL__BITWISE
+=for apidoc Amnh||WARN_EXPERIMENTAL__CONST_ATTR
+=for apidoc Amnh||WARN_EXPERIMENTAL__RE_STRICT
+=for apidoc Amnh||WARN_EXPERIMENTAL__REFALIASING
+=for apidoc Amnh||WARN_EXPERIMENTAL__WIN32_PERLIO
+=for apidoc Amnh||WARN_LOCALE
+=for apidoc Amnh||WARN_MISSING
+=for apidoc Amnh||WARN_REDUNDANT
+=for apidoc Amnh||WARN_EXPERIMENTAL__DECLARED_REFS
+=for apidoc Amnh||WARN_EXPERIMENTAL__ALPHA_ASSERTIONS
+=for apidoc Amnh||WARN_EXPERIMENTAL__SCRIPT_RUN
+=for apidoc Amnh||WARN_SHADOW
+=for apidoc Amnh||WARN_EXPERIMENTAL__PRIVATE_USE
+=for apidoc Amnh||WARN_EXPERIMENTAL__UNIPROP_WILDCARDS
+=for apidoc Amnh||WARN_EXPERIMENTAL__VLB
+=for apidoc Amnh||WARN_EXPERIMENTAL__ISA
+
+=cut
+*/
+
 /* end of file warnings.h */
 
 /* ex: set ro: */