summaryrefslogtreecommitdiff
path: root/sv.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-09-05 22:18:06 -0600
committerKarl Williamson <khw@cpan.org>2020-11-29 08:08:46 -0700
commitb29c03aee096d5715db9fbc42b62edd094c513e9 (patch)
tree85ae79fbe312fe7258fc7e4afc30b22e26b4ec38 /sv.h
parentb0312014d6c1804920d2b687a5fa5645b445ce9f (diff)
downloadperl-b29c03aee096d5715db9fbc42b62edd094c513e9.tar.gz
perlapi: Consolidate svREFCNT_dec-ish entries
Diffstat (limited to 'sv.h')
-rw-r--r--sv.h9
1 files changed, 4 insertions, 5 deletions
diff --git a/sv.h b/sv.h
index d8ace323c9..2aae6b63b8 100644
--- a/sv.h
+++ b/sv.h
@@ -320,12 +320,11 @@ C<SvREFCNT_inc_simple_void_NN> can only be used with expressions without side
effects, you don't need the return value, and you know C<sv> is not C<NULL>.
=for apidoc SvREFCNT_dec
-Decrements the reference count of the given SV. C<sv> may be C<NULL>.
+=for apidoc_item SvREFCNT_dec_NN
-=for apidoc SvREFCNT_dec_NN
-Same as C<SvREFCNT_dec>, but can only be used if you know C<sv>
-is not C<NULL>. Since we don't have to check the NULLness, it's faster
-and smaller.
+These decrement the reference count of the given SV.
+
+C<SvREFCNT_dec_NN> may only be used when C<sv> is known to not be C<NULL>.
=for apidoc Am|svtype|SvTYPE|SV* sv
Returns the type of the SV. See C<L</svtype>>.