@@ -2965,31 +2965,34 @@ last-inclusive range.
2965
2965
CPAN::Unpack show any users outside the core.
2966
2966
2967
2967
=for apidoc_section $warning
2968
- =for apidoc dm||deprecate|U32 category|"message"
2969
- Wrapper around Perl_ck_warner_d() to produce a deprecated warning in the
2970
- given category with an appropriate message. The C<message> argument must
2971
- be a C string. The string " is deprecated" will automatically be added
2972
- to the end of the C<message>.
2973
-
2974
- =for apidoc dm||deprecate_disappears_in|U32 category|"when"|"message"
2975
- Wrapper around Perl_ck_warner_d() to produce a deprecated warning in the
2976
- given category with an appropriate message that the construct referred
2977
- to by the message will disappear in a specific release. The C<when> and
2978
- C<message> arguments must be a C string. The C<when> string is expected
2979
- to be of the form "5.40", with no minor element in the version. The actual
2980
- message output will be the result of the following expression C<message
2981
- " is deprecated, and will disappear in Perl " when> which is why C<message>
2982
- and C<when> must be literal C strings.
2983
-
2984
- =for apidoc dm||deprecate_fatal_in|U32 category|"when"|"message"
2985
- Wrapper around Perl_ck_warner_d() to produce a deprecated warning in the
2986
- given category with an appropriate message that the construct referred
2987
- to by the message will become fatal in a specific release. The C<when>
2988
- and C<message> arguments must be a C string. The C<when> string is expected
2989
- to be of the form "5.40", with no minor element in the version. The actual
2990
- message output will be the result of the following expression C<message " is
2991
- deprecated, and will become fatal in Perl " when> which is why C<message>
2992
- and C<when> must be literal C strings.
2968
+ =for apidoc dm||deprecate|U32 category|"message"
2969
+ =for apidoc_item||deprecate_disappears_in|U32 category|"when"|"message"
2970
+ =for apidoc_item||deprecate_fatal_in|U32 category|"when"|"message"
2971
+
2972
+ These each are wrappers around Perl_ck_warner_d() to produce a deprecated
2973
+ warning in the single category given by C<category>, with an appropriate
2974
+ message.
2975
+
2976
+ They differ in the details of the message output, but all use as a base, the
2977
+ C<message> argument, which must be a literal C string enclosed in
2978
+ double-quotes.
2979
+
2980
+ In plain C<deprecate>, the string " is deprecated" will automatically be
2981
+ added to the end of C<message>, yielding
2982
+
2983
+ <message> is deprecated
2984
+
2985
+ The other two take a third argument C<when>, which is a literal C string in the
2986
+ form like "5.40". C<when> indicates in what release the axe is scheduled to
2987
+ fall.
2988
+
2989
+ In C<<deprecate_disappears_in>, the actual message output will be of the form:
2990
+
2991
+ <message> is deprecated, and will disappear in Perl <when>
2992
+
2993
+ In C<deprecate_fatal_in>, the message will be of the form:
2994
+
2995
+ <message> is deprecated, and will become fatal in Perl <when>
2993
2996
2994
2997
=cut
2995
2998
*/
0 commit comments