summaryrefslogtreecommitdiff
path: root/cop.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2019-06-25 08:40:05 -0600
committerKarl Williamson <khw@cpan.org>2019-06-25 09:07:12 -0600
commit78342678c3d43495ec0526969486d748b07f0525 (patch)
tree91ac0dcdeacea9d8c052f07e4a8633a3d5340fe0 /cop.h
parent5c696bd319ee40ee8ca0a317377f9c7b73d1fa8b (diff)
downloadperl-78342678c3d43495ec0526969486d748b07f0525.tar.gz
Fix apidoc macro entries
This makes various fixes to the text that is used to generate the documentation. The dominant change is to add the 'n' flag to indicate that the macro takes no arguments. A couple should have been marked with a D (for deprecated) flag, and a couple were missing parameters, and a couple were missing return values. These were spotted by using Devel::PPPort on them.
Diffstat (limited to 'cop.h')
-rw-r--r--cop.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/cop.h b/cop.h
index fca2aa755c..b9b61faa76 100644
--- a/cop.h
+++ b/cop.h
@@ -922,27 +922,27 @@ struct context {
*/
/*
-=for apidoc AmU||G_SCALAR
+=for apidoc AmnU||G_SCALAR
Used to indicate scalar context. See C<L</GIMME_V>>, C<L</GIMME>>, and
L<perlcall>.
-=for apidoc AmU||G_ARRAY
+=for apidoc AmnU||G_ARRAY
Used to indicate list context. See C<L</GIMME_V>>, C<L</GIMME>> and
L<perlcall>.
-=for apidoc AmU||G_VOID
+=for apidoc AmnU||G_VOID
Used to indicate void context. See C<L</GIMME_V>> and L<perlcall>.
-=for apidoc AmU||G_DISCARD
+=for apidoc AmnU||G_DISCARD
Indicates that arguments returned from a callback should be discarded. See
L<perlcall>.
-=for apidoc AmU||G_EVAL
+=for apidoc AmnU||G_EVAL
Used to force a Perl C<eval> wrapper around a callback. See
L<perlcall>.
-=for apidoc AmU||G_NOARGS
+=for apidoc AmnU||G_NOARGS
Indicates that no arguments are being sent to a callback. See
L<perlcall>.
@@ -1101,7 +1101,7 @@ typedef struct stackinfo PERL_SI;
=for apidoc Amns||dMULTICALL
Declare local variables for a multicall. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
-=for apidoc Amns||PUSH_MULTICALL
+=for apidoc Ams||PUSH_MULTICALL|CV* the_cv
Opening bracket for a lightweight callback.
See L<perlcall/LIGHTWEIGHT CALLBACKS>.