This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Document UVf, as deprecated
authorKarl Williamson <khw@cpan.org>
Sat, 17 Oct 2020 21:49:53 +0000 (15:49 -0600)
committerKarl Williamson <khw@cpan.org>
Mon, 23 Nov 2020 16:52:06 +0000 (09:52 -0700)
perl.h

diff --git a/perl.h b/perl.h
index 3382dad..f837459 100644 (file)
--- a/perl.h
+++ b/perl.h
@@ -3770,7 +3770,13 @@ EXTERN_C int perl_tsa_mutex_unlock(perl_mutex* mutex)
 #define PNfARG(pn) (int)1, (UV)PadnameLEN(pn), (void *)PadnamePV(pn)
 
 #ifdef PERL_CORE
-/* not used; but needed for backward compatibility with XS code? - RMB */
+/* not used; but needed for backward compatibility with XS code? - RMB
+=for apidoc AmnD|const char *|UVf
+
+Obsolete form of C<UVuf>, which you should convert to instead use
+
+=cut
+*/
 #  undef UVf
 #elif !defined(UVf)
 #  define UVf UVuf