This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document SvVSTRING_mg
authorKarl Williamson <khw@cpan.org>
Sat, 18 Jul 2020 14:36:09 +0000 (08:36 -0600)
committerKarl Williamson <khw@cpan.org>
Sun, 23 Aug 2020 02:55:35 +0000 (20:55 -0600)
sv.h

diff --git a/sv.h b/sv.h
index 91cc39c..2538741 100644 (file)
--- a/sv.h
+++ b/sv.h
@@ -949,7 +949,13 @@ in gv.h: */
 
 #define SvVOK(sv)              (SvMAGICAL(sv)                          \
                                 && mg_find(sv,PERL_MAGIC_vstring))
-/* returns the vstring magic, if any */
+/*
+=for apidoc Am|MAGIC*|SvVSTRING_mg|SV * sv
+
+Returns the vstring magic, or NULL if none
+
+=cut
+*/
 #define SvVSTRING_mg(sv)       (SvMAGICAL(sv) \
                                 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)