This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Clarify return value of SvREFCNT_inc()
authorKarl Williamson <public@khwilliamson.com>
Thu, 20 Dec 2012 23:16:26 +0000 (16:16 -0700)
committerKarl Williamson <public@khwilliamson.com>
Sat, 22 Dec 2012 16:48:20 +0000 (09:48 -0700)
sv.h

diff --git a/sv.h b/sv.h
index 09489b7..28cdf3b 100644 (file)
--- a/sv.h
+++ b/sv.h
@@ -244,7 +244,7 @@ struct p5rx {
 Returns the value of the object's reference count.
 
 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
-Increments the reference count of the given SV.
+Increments the reference count of the given SV, returning the SV.
 
 All of the following SvREFCNT_inc* macros are optimized versions of
 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.