This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pad.c: Document cv_name
authorFather Chrysostomos <sprout@cpan.org>
Thu, 28 Aug 2014 23:03:22 +0000 (16:03 -0700)
committerFather Chrysostomos <sprout@cpan.org>
Mon, 15 Sep 2014 13:19:31 +0000 (06:19 -0700)
pad.c

diff --git a/pad.c b/pad.c
index 04dff00..285c204 100644 (file)
--- a/pad.c
+++ b/pad.c
@@ -2228,6 +2228,21 @@ Perl_cv_clone_into(pTHX_ CV *proto, CV *target)
     return S_cv_clone(aTHX_ proto, target, NULL);
 }
 
+/*
+=for apidoc cv_name
+
+Returns an SV containing the name of the CV, mainly for use in error
+reporting.  The CV may actually be a GV instead, in which case the returned
+SV holds the GV's name.  Anything other than a GV or CV will be treated as
+a string already holding the sub name.
+
+An SV may be passed as a second argument.  If so, the name will be assigned
+to it and it will be returned.  Otherwise the returned SV will be a new
+mortal.
+
+=cut
+*/
+
 SV *
 Perl_cv_name(pTHX_ CV *cv, SV *sv)
 {