summaryrefslogtreecommitdiff
path: root/sv.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-07-18 08:36:09 -0600
committerKarl Williamson <khw@cpan.org>2020-08-22 20:55:35 -0600
commitc4d5dfab7d79e1091d93e1f865e45244002f7513 (patch)
tree270fd4b85479fc06b574d4a564f9bbd8b2706f29 /sv.h
parent6600fe70078403752b6f134b4103ab348446352c (diff)
downloadperl-c4d5dfab7d79e1091d93e1f865e45244002f7513.tar.gz
Document SvVSTRING_mg
Diffstat (limited to 'sv.h')
-rw-r--r--sv.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/sv.h b/sv.h
index 91cc39c7aa..2538741c53 100644
--- 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)