diff options
| author | Karl Williamson <khw@cpan.org> | 2019-06-25 08:40:05 -0600 |
|---|---|---|
| committer | Karl Williamson <khw@cpan.org> | 2019-06-25 09:07:12 -0600 |
| commit | 78342678c3d43495ec0526969486d748b07f0525 (patch) | |
| tree | 91ac0dcdeacea9d8c052f07e4a8633a3d5340fe0 /pad.c | |
| parent | 5c696bd319ee40ee8ca0a317377f9c7b73d1fa8b (diff) | |
| download | perl-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 'pad.c')
| -rw-r--r-- | pad.c | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -121,12 +121,12 @@ to be generated in evals, such as For state vars, C<SVs_PADSTALE> is overloaded to mean 'not yet initialised', but this internal state is stored in a separate pad entry. -=for apidoc AmxU|PADNAMELIST *|PL_comppad_name +=for apidoc AmnxU|PADNAMELIST *|PL_comppad_name During compilation, this points to the array containing the names part of the pad for the currently-compiling code. -=for apidoc AmxU|PAD *|PL_comppad +=for apidoc AmnxU|PAD *|PL_comppad During compilation, this points to the array containing the values part of the pad for the currently-compiling code. (At runtime a CV may @@ -134,7 +134,7 @@ have many such value arrays; at compile time just one is constructed.) At runtime, this points to the array containing the currently-relevant values for the pad for the currently-executing code. -=for apidoc AmxU|SV **|PL_curpad +=for apidoc AmnxU|SV **|PL_curpad Points directly to the body of the L</PL_comppad> array. (I.e., this is C<PadARRAY(PL_comppad)>.) |