summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Mitchell <davem@iabyn.com>2015-05-18 12:39:12 +0100
committerDavid Mitchell <davem@iabyn.com>2015-05-18 13:29:43 +0100
commit99c50ab920d24899d5a629773c3013d1db5a1fdd (patch)
tree09afb0568d433103c0c5b46b120a350d358090d4
parent96623e3152b3f622bf7b2d58384465be6752900d (diff)
downloadperl-99c50ab920d24899d5a629773c3013d1db5a1fdd.tar.gz
clarify apidoc for Perl_sv_get_backrefs
-rw-r--r--sv.c15
1 files changed, 7 insertions, 8 deletions
diff --git a/sv.c b/sv.c
index 2bb03464ee..8440763bef 100644
--- a/sv.c
+++ b/sv.c
@@ -5950,14 +5950,13 @@ Perl_sv_rvweaken(pTHX_ SV *const sv)
/*
=for apidoc sv_get_backrefs
-If the sv is the target of a weakrefence then return
-the backrefs structure associated with the sv, otherwise
-return NULL.
-
-When returning a non-null result the type of the return
-is relevant. If it is an AV then the contents of the AV
-are the weakrefs which point at this item. If it is any
-other type then the item itself is the weakref.
+If the sv is the target of a weak reference then it returns the back
+references structure associated with the sv; otherwise return NULL.
+
+When returning a non-null result the type of the return is relevant. If it
+is an AV then the elements of the AV are the weak reference RVs which
+point at this item. If it is any other type then the item itself is the
+weak reference.
See also Perl_sv_add_backref(), Perl_sv_del_backref(),
Perl_sv_kill_backrefs()