From 3734d2f5d38a7779376358fb891b3d3a38e6c0d8 Mon Sep 17 00:00:00 2001 From: Karl Williamson Date: Wed, 8 Jun 2022 06:57:59 -0600 Subject: Change autodoc flag This should be being used only in core, as its only use is for autodoc. Change the flag name to be more mnemonic, freeing up its current name for another use. --- XSUB.h | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'XSUB.h') diff --git a/XSUB.h b/XSUB.h index 6cd6d2e4aa..b1a9aeab3f 100644 --- a/XSUB.h +++ b/XSUB.h @@ -74,28 +74,28 @@ Macro to declare an XSUB and its C parameter list explicitly exporting the symbo Macro used by C> and C> to declare a function prototype. You probably shouldn't be using this directly yourself. -=for apidoc Amns||dAX +=for apidoc Amn;||dAX Sets up the C variable. This is usually handled automatically by C by calling C. -=for apidoc Amns||dAXMARK +=for apidoc Amn;||dAXMARK Sets up the C variable and stack marker variable C. This is usually handled automatically by C by calling C. -=for apidoc Amns||dITEMS +=for apidoc Amn;||dITEMS Sets up the C variable. This is usually handled automatically by C by calling C. -=for apidoc Amns||dXSARGS +=for apidoc Amn;||dXSARGS Sets up stack and mark pointers for an XSUB, calling C and C. Sets up the C and C variables by calling C and C. This is usually handled automatically by C. -=for apidoc Amns||dXSI32 +=for apidoc Amn;||dXSI32 Sets up the C variable for an XSUB which has aliases. This is usually handled automatically by C. -=for apidoc Amns||dUNDERBAR +=for apidoc Amn;||dUNDERBAR Sets up any variable needed by the C macro. It used to define C, but it is currently a noop. However, it is strongly advised to still use it for ensuring past and future compatibility. @@ -261,16 +261,16 @@ Return a double from an XSUB immediately. Uses C. =for apidoc Am|void|XSRETURN_PV|char* str Return a copy of a string from an XSUB immediately. Uses C. -=for apidoc Amns||XSRETURN_NO +=for apidoc Amn;||XSRETURN_NO Return C<&PL_sv_no> from an XSUB immediately. Uses C. -=for apidoc Amns||XSRETURN_YES +=for apidoc Amn;||XSRETURN_YES Return C<&PL_sv_yes> from an XSUB immediately. Uses C. -=for apidoc Amns||XSRETURN_UNDEF +=for apidoc Amn;||XSRETURN_UNDEF Return C<&PL_sv_undef> from an XSUB immediately. Uses C. -=for apidoc Amns||XSRETURN_EMPTY +=for apidoc Amn;||XSRETURN_EMPTY Return an empty list from an XSUB immediately. =for apidoc AmU||newXSproto|char* name|XSUBADDR_t f|char* filename|const char *proto @@ -282,18 +282,18 @@ The version identifier for an XS module. This is usually handled automatically by C. See C>. -=for apidoc Amns||XS_VERSION_BOOTCHECK +=for apidoc Amn;||XS_VERSION_BOOTCHECK Macro to verify that a PM module's C<$VERSION> variable matches the XS module's C variable. This is usually handled automatically by C. See L. -=for apidoc Amns||XS_APIVERSION_BOOTCHECK +=for apidoc Amn;||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. =for apidoc_section $exceptions -=for apidoc Amns||dXCPT +=for apidoc Amn;||dXCPT Set up necessary local variables for exception handling. See L. @@ -306,7 +306,7 @@ Ends a try block. See L. =for apidoc AmnU||XCPT_CATCH Introduces a catch block. See L. -=for apidoc Amns||XCPT_RETHROW +=for apidoc Amn;||XCPT_RETHROW Rethrows a previously caught exception. See L. =cut -- cgit v1.2.1