This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document SvSHARED_HASH
authorKarl Williamson <khw@cpan.org>
Thu, 27 Aug 2020 17:03:44 +0000 (11:03 -0600)
committerKarl Williamson <khw@cpan.org>
Sun, 29 Nov 2020 16:06:35 +0000 (09:06 -0700)
sv.h

diff --git a/sv.h b/sv.h
index 2aae6b6..f753a94 100644 (file)
--- a/sv.h
+++ b/sv.h
@@ -1925,6 +1925,12 @@ scalar.
 
 #define SvSHARED_HEK_FROM_PV(pvx) \
        ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
+/*
+=for apidoc Am|struct hek*|SvSHARED_HASH|SV * sv
+Returns the hash for C<sv> created by C<L</newSVpvn_share>>.
+
+=cut
+*/
 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
 
 /* flag values for sv_*_flags functions */