diff options
author | David Mitchell <davem@iabyn.com> | 2015-05-18 12:39:12 +0100 |
---|---|---|
committer | David Mitchell <davem@iabyn.com> | 2015-05-18 13:29:43 +0100 |
commit | 99c50ab920d24899d5a629773c3013d1db5a1fdd (patch) | |
tree | 09afb0568d433103c0c5b46b120a350d358090d4 /sv.c | |
parent | 96623e3152b3f622bf7b2d58384465be6752900d (diff) | |
download | perl-99c50ab920d24899d5a629773c3013d1db5a1fdd.tar.gz |
clarify apidoc for Perl_sv_get_backrefs
Diffstat (limited to 'sv.c')
-rw-r--r-- | sv.c | 15 |
1 files changed, 7 insertions, 8 deletions
@@ -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() |