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 /XSUB.h | |
| 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 'XSUB.h')
| -rw-r--r-- | XSUB.h | 14 |
1 files changed, 7 insertions, 7 deletions
@@ -47,7 +47,7 @@ XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">. =for apidoc Am|SV*|ST|int ix Used to access elements on the XSUB's stack. -=for apidoc AmU||XS +=for apidoc AmnU||XS Macro to declare an XSUB and its C parameter list. This is handled by C<xsubpp>. It is the same as using the more explicit C<XS_EXTERNAL> macro. @@ -56,7 +56,7 @@ Macro to declare an XSUB and its C parameter list without exporting the symbols. This is handled by C<xsubpp> and generally preferable over exporting the XSUB symbols unnecessarily. -=for apidoc AmU||XS_EXTERNAL +=for apidoc AmnU||XS_EXTERNAL Macro to declare an XSUB and its C parameter list explicitly exporting the symbols. =for apidoc Amns||dAX @@ -85,7 +85,7 @@ Sets up any variable needed by the C<UNDERBAR> macro. It used to define C<padoff_du>, but it is currently a noop. However, it is strongly advised to still use it for ensuring past and future compatibility. -=for apidoc AmU||UNDERBAR +=for apidoc AmnU||UNDERBAR The SV* corresponding to the C<$_> variable. Works even if there is a lexical C<$_> in scope. @@ -263,7 +263,7 @@ Return an empty list from an XSUB immediately. Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to the subs. -=for apidoc AmU||XS_VERSION +=for apidoc AmnU||XS_VERSION The version identifier for an XS module. This is usually handled automatically by C<ExtUtils::MakeMaker>. See C<L</XS_VERSION_BOOTCHECK>>. @@ -283,13 +283,13 @@ matches the api version of the perl interpreter it's being loaded into. Set up necessary local variables for exception handling. See L<perlguts/"Exception Handling">. -=for apidoc AmU||XCPT_TRY_START +=for apidoc AmnU||XCPT_TRY_START Starts a try block. See L<perlguts/"Exception Handling">. -=for apidoc AmU||XCPT_TRY_END +=for apidoc AmnU||XCPT_TRY_END Ends a try block. See L<perlguts/"Exception Handling">. -=for apidoc AmU||XCPT_CATCH +=for apidoc AmnU||XCPT_CATCH Introduces a catch block. See L<perlguts/"Exception Handling">. =for apidoc Amns||XCPT_RETHROW |