diff --git a/handy.h b/handy.h index fec7d83e3bd5..d06292dd6ca9 100644 --- a/handy.h +++ b/handy.h @@ -2965,31 +2965,34 @@ last-inclusive range. CPAN::Unpack show any users outside the core. =for apidoc_section $warning -=for apidoc dm||deprecate|U32 category|"message" -Wrapper around Perl_ck_warner_d() to produce a deprecated warning in the -given category with an appropriate message. The C argument must -be a C string. The string " is deprecated" will automatically be added -to the end of the C. - -=for apidoc dm||deprecate_disappears_in|U32 category|"when"|"message" -Wrapper around Perl_ck_warner_d() to produce a deprecated warning in the -given category with an appropriate message that the construct referred -to by the message will disappear in a specific release. The C and -C arguments must be a C string. The C string is expected -to be of the form "5.40", with no minor element in the version. The actual -message output will be the result of the following expression C which is why C -and C must be literal C strings. - -=for apidoc dm||deprecate_fatal_in|U32 category|"when"|"message" -Wrapper around Perl_ck_warner_d() to produce a deprecated warning in the -given category with an appropriate message that the construct referred -to by the message will become fatal in a specific release. The C -and C arguments must be a C string. The C string is expected -to be of the form "5.40", with no minor element in the version. The actual -message output will be the result of the following expression C which is why C -and C must be literal C strings. +=for apidoc dm||deprecate|U32 category|"message" +=for apidoc_item||deprecate_disappears_in|U32 category|"when"|"message" +=for apidoc_item||deprecate_fatal_in|U32 category|"when"|"message" + +These each are wrappers around Perl_ck_warner_d() to produce a deprecated +warning in the single category given by C, with an appropriate +message. + +They differ in the details of the message output, but all use as a base, the +C argument, which must be a literal C string enclosed in +double-quotes. + +In plain C, the string " is deprecated" will automatically be +added to the end of C, yielding + + is deprecated + +The other two take a third argument C, which is a literal C string in the +form like "5.40". C indicates in what release the axe is scheduled to +fall. + +In C<, the actual message output will be of the form: + + is deprecated, and will disappear in Perl + +In C, the message will be of the form: + + is deprecated, and will become fatal in Perl =cut */