summaryrefslogtreecommitdiff
path: root/perlvars.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 /perlvars.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 'perlvars.h')
-rw-r--r--perlvars.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/perlvars.h b/perlvars.h
index 466c515ebb..df5b2f8c64 100644
--- a/perlvars.h
+++ b/perlvars.h
@@ -114,7 +114,7 @@ PERLVAR(G, C_locale_obj, locale_t)
PERLVARI(G, watch_pvx, char *, NULL)
/*
-=for apidoc AmU|Perl_check_t *|PL_check
+=for apidoc AmnU|Perl_check_t *|PL_check
Array, indexed by opcode, of functions that will be called for the "check"
phase of optree building during compilation of Perl code. For most (but
@@ -176,7 +176,7 @@ PERLVARI(G, my_cxt_index, int, 0)
PERLVARI(G, veto_cleanup, int, FALSE) /* exit without cleanup */
/*
-=for apidoc AmUx|Perl_keyword_plugin_t|PL_keyword_plugin
+=for apidoc AmnUx|Perl_keyword_plugin_t|PL_keyword_plugin
Function pointer, pointing at a function used to handle extended keywords.
The function should be declared as