diff options
author | Karl Williamson <khw@cpan.org> | 2019-05-28 12:55:19 -0600 |
---|---|---|
committer | Karl Williamson <khw@cpan.org> | 2019-05-30 18:13:29 -0600 |
commit | 4e5171e9e72a8e719a45a205fb6d9514c2e8dccd (patch) | |
tree | 2c4955341fa67bcf5719982019a9fa52989b1702 | |
parent | 73060c4e2338e283341aabb27f4136e51f4f7b64 (diff) | |
download | perl-4e5171e9e72a8e719a45a205fb6d9514c2e8dccd.tar.gz |
Add 'n' flag to various =for apidoc lines
This indicates to not output the macro with parentheses for parameters.
Currently that doesn't happen anyway, but a future commit will change
things so this is required (so that a bug can be fixed)
-rw-r--r-- | XSUB.h | 28 | ||||
-rw-r--r-- | cop.h | 8 | ||||
-rw-r--r-- | pp.h | 10 | ||||
-rw-r--r-- | scope.h | 8 |
4 files changed, 27 insertions, 27 deletions
@@ -59,28 +59,28 @@ symbols unnecessarily. =for apidoc AmU||XS_EXTERNAL Macro to declare an XSUB and its C parameter list explicitly exporting the symbols. -=for apidoc Ams||dAX +=for apidoc Amns||dAX Sets up the C<ax> variable. This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>. -=for apidoc Ams||dAXMARK +=for apidoc Amns||dAXMARK Sets up the C<ax> variable and stack marker variable C<mark>. This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>. -=for apidoc Ams||dITEMS +=for apidoc Amns||dITEMS Sets up the C<items> variable. This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>. -=for apidoc Ams||dXSARGS +=for apidoc Amns||dXSARGS Sets up stack and mark pointers for an XSUB, calling C<dSP> and C<dMARK>. Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>. This is usually handled automatically by C<xsubpp>. -=for apidoc Ams||dXSI32 +=for apidoc Amns||dXSI32 Sets up the C<ix> variable for an XSUB which has aliases. This is usually handled automatically by C<xsubpp>. -=for apidoc Ams||dUNDERBAR +=for apidoc Amns||dUNDERBAR 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. @@ -245,16 +245,16 @@ Return a double from an XSUB immediately. Uses C<XST_mNV>. =for apidoc Am|void|XSRETURN_PV|char* str Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>. -=for apidoc Ams||XSRETURN_NO +=for apidoc Amns||XSRETURN_NO Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>. -=for apidoc Ams||XSRETURN_YES +=for apidoc Amns||XSRETURN_YES Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>. -=for apidoc Ams||XSRETURN_UNDEF +=for apidoc Amns||XSRETURN_UNDEF Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>. -=for apidoc Ams||XSRETURN_EMPTY +=for apidoc Amns||XSRETURN_EMPTY Return an empty list from an XSUB immediately. =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions @@ -268,18 +268,18 @@ The version identifier for an XS module. This is usually handled automatically by C<ExtUtils::MakeMaker>. See C<L</XS_VERSION_BOOTCHECK>>. -=for apidoc Ams||XS_VERSION_BOOTCHECK +=for apidoc Amns||XS_VERSION_BOOTCHECK Macro to verify that a PM module's C<$VERSION> variable matches the XS module's C<XS_VERSION> variable. This is usually handled automatically by C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">. -=for apidoc Ams||XS_APIVERSION_BOOTCHECK +=for apidoc Amns||XS_APIVERSION_BOOTCHECK Macro to verify that the perl api version an XS module has been compiled against matches the api version of the perl interpreter it's being loaded into. =head1 Exception Handling (simple) Macros -=for apidoc Ams||dXCPT +=for apidoc Amns||dXCPT Set up necessary local variables for exception handling. See L<perlguts/"Exception Handling">. @@ -292,7 +292,7 @@ Ends a try block. See L<perlguts/"Exception Handling">. =for apidoc AmU||XCPT_CATCH Introduces a catch block. See L<perlguts/"Exception Handling">. -=for apidoc Ams||XCPT_RETHROW +=for apidoc Amns||XCPT_RETHROW Rethrows a previously caught exception. See L<perlguts/"Exception Handling">. =cut @@ -1098,17 +1098,17 @@ typedef struct stackinfo PERL_SI; /* =head1 Multicall Functions -=for apidoc Ams||dMULTICALL +=for apidoc Amns||dMULTICALL Declare local variables for a multicall. See L<perlcall/LIGHTWEIGHT CALLBACKS>. -=for apidoc Ams||PUSH_MULTICALL +=for apidoc Amns||PUSH_MULTICALL Opening bracket for a lightweight callback. See L<perlcall/LIGHTWEIGHT CALLBACKS>. -=for apidoc Ams||MULTICALL +=for apidoc Amns||MULTICALL Make a lightweight callback. See L<perlcall/LIGHTWEIGHT CALLBACKS>. -=for apidoc Ams||POP_MULTICALL +=for apidoc Amns||POP_MULTICALL Closing bracket for a lightweight callback. See L<perlcall/LIGHTWEIGHT CALLBACKS>. @@ -24,7 +24,7 @@ Stack marker variable for the XSUB. See C<L</dMARK>>. Opening bracket for arguments on a callback. See C<L</PUTBACK>> and L<perlcall>. -=for apidoc Ams||dSP +=for apidoc Amns||dSP Declares a local copy of perl's stack pointer for the XSUB, available via the C<SP> macro. See C<L</SP>>. @@ -35,17 +35,17 @@ a local copy of perl's stack pointer, available via the C<SP> macro. See C<L<perlapi/SP>>. (Available for backward source code compatibility with the old (Perl 5.005) thread model.) -=for apidoc Ams||dMARK +=for apidoc Amns||dMARK Declare a stack marker variable, C<mark>, for the XSUB. See C<L</MARK>> and C<L</dORIGMARK>>. -=for apidoc Ams||dORIGMARK +=for apidoc Amns||dORIGMARK Saves the original stack mark for the XSUB. See C<L</ORIGMARK>>. =for apidoc AmU||ORIGMARK The original stack mark for the XSUB. See C<L</dORIGMARK>>. -=for apidoc Ams||SPAGAIN +=for apidoc Amns||SPAGAIN Refetch the stack pointer. Used after a callback. See L<perlcall>. =cut */ @@ -102,7 +102,7 @@ Refetch the stack pointer. Used after a callback. See L<perlcall>. #define DIE return Perl_die /* -=for apidoc Ams||PUTBACK +=for apidoc Amns||PUTBACK Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>. See C<L</PUSHMARK>> and L<perlcall> for other uses. @@ -153,18 +153,18 @@ /* =head1 Callback Functions -=for apidoc Ams||SAVETMPS +=for apidoc Amns||SAVETMPS Opening bracket for temporaries on a callback. See C<L</FREETMPS>> and L<perlcall>. -=for apidoc Ams||FREETMPS +=for apidoc Amns||FREETMPS Closing bracket for temporaries on a callback. See C<L</SAVETMPS>> and L<perlcall>. -=for apidoc Ams||ENTER +=for apidoc Amns||ENTER Opening bracket on a callback. See C<L</LEAVE>> and L<perlcall>. -=for apidoc Ams||LEAVE +=for apidoc Amns||LEAVE Closing bracket on a callback. See C<L</ENTER>> and L<perlcall>. =for apidoc Ams||ENTER_with_name(name) |