summaryrefslogtreecommitdiff
path: root/pad.c
diff options
context:
space:
mode:
authorFather Chrysostomos <sprout@cpan.org>2011-10-08 23:31:07 -0700
committerFather Chrysostomos <sprout@cpan.org>2011-10-09 23:14:07 -0700
commit13087dd8e6c0257d4e1c28a81f9976d5e382e425 (patch)
treecad7881ca51996137c74c4db6ea8f459094665ce /pad.c
parent89fc9e2a93d8f1efaca9c57135763a5342ecdd36 (diff)
downloadperl-13087dd8e6c0257d4e1c28a81f9976d5e382e425.tar.gz
Fix up pad_check_dup entry in perlintern
When the pad API was added, the special m|pad_check_dup|SV *name|U32 flags|const HV *ourstash sequence was added to pad.c, but that is unnecessary as it is listed in embed.fnc. Also it is not correct, as the name of the function is in the return value field. So this restore it back to the simple ‘=for apidoc pad_check_dup’. The description of the function was in plain text like this: Check for duplicate declarations: report any of: * a my in the current scope with the same name; * an our (anywhere in the pad) with the same name and the same stash as C<ourstash> C<is_our> indicates that the name to check is an 'our' declaration which gets rewrapped in rendered pod. So this patch changes it to use a verbatim block (as autodoc.pl doesn’t seem to like pod lists).
Diffstat (limited to 'pad.c')
-rw-r--r--pad.c10
1 files changed, 6 insertions, 4 deletions
diff --git a/pad.c b/pad.c
index c767b550c1..eb0cd5c58e 100644
--- a/pad.c
+++ b/pad.c
@@ -762,13 +762,15 @@ Perl_pad_add_anon(pTHX_ CV* func, I32 optype)
}
/*
-=for apidoc m|pad_check_dup|SV *name|U32 flags|const HV *ourstash
+=for apidoc pad_check_dup
Check for duplicate declarations: report any of:
+
* a my in the current scope with the same name;
- * an our (anywhere in the pad) with the same name and the same stash
- as C<ourstash>
-C<is_our> indicates that the name to check is an 'our' declaration
+ * an our (anywhere in the pad) with the same name and the
+ same stash as C<ourstash>
+
+C<is_our> indicates that the name to check is an 'our' declaration.
=cut
*/