diff options
author | Karl Williamson <khw@cpan.org> | 2019-05-29 18:33:25 -0600 |
---|---|---|
committer | Karl Williamson <khw@cpan.org> | 2019-05-30 18:13:29 -0600 |
commit | 44170c9a70d967e18e7d442d25d642a2e9359099 (patch) | |
tree | c438595b4123c2b1362855766483f799a9d8c2fc | |
parent | 8902d5545f28d09d06be64c2fec58139f1492af0 (diff) | |
download | perl-44170c9a70d967e18e7d442d25d642a2e9359099.tar.gz |
Remove redundant info on =for apidoc lines
This information is already in embed.fnc, and we know it compiles. Some
of this information is now out-of-date. Get rid of it.
There was one bit of information that was (apparently) wrong in
embed.fnc. The apidoc line asked that there be no usage example
generated for newXS. I added that flag to the embed.fnc entry.
-rw-r--r-- | av.h | 2 | ||||
-rw-r--r-- | embed.fnc | 2 | ||||
-rw-r--r-- | hv.c | 20 | ||||
-rw-r--r-- | inline.h | 6 | ||||
-rw-r--r-- | mathoms.c | 2 | ||||
-rw-r--r-- | mg.c | 4 | ||||
-rw-r--r-- | op.c | 110 | ||||
-rw-r--r-- | pad.c | 54 | ||||
-rw-r--r-- | perl.c | 30 | ||||
-rw-r--r-- | toke.c | 48 | ||||
-rw-r--r-- | util.c | 28 |
11 files changed, 153 insertions, 153 deletions
@@ -49,7 +49,7 @@ Null AV pointer. =for apidoc Am|int|AvFILL|AV* av Same as C<av_top_index()> or C<av_tindex()>. -=for apidoc Am|int|av_tindex|AV* av +=for apidoc av_tindex Same as C<av_top_index()>. =cut @@ -1189,7 +1189,7 @@ pX |CV * |newXS_deffile |NN const char *name|NN XSUBADDR_t subaddr Apx |CV * |newXS_flags |NULLOK const char *name|NN XSUBADDR_t subaddr\ |NN const char *const filename \ |NULLOK const char *const proto|U32 flags -Apd |CV* |newXS |NULLOK const char *name|NN XSUBADDR_t subaddr\ +ApdU |CV* |newXS |NULLOK const char *name|NN XSUBADDR_t subaddr\ |NN const char *filename ApmdbR |AV* |newAV ApR |OP* |newAVREF |NN OP* o @@ -1671,7 +1671,7 @@ Perl_newHVhv(pTHX_ HV *ohv) } /* -=for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv +=for apidoc hv_copy_hints_hv A specialised version of L</newHVhv> for copying C<%^H>. C<ohv> must be a pointer to a hash (which may have C<%^H> magic, but should be generally @@ -3249,7 +3249,7 @@ S_refcounted_he_value(pTHX_ const struct refcounted_he *he) } /* -=for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags +=for apidoc refcounted_he_chain_2hv Generates and returns a C<HV *> representing the content of a C<refcounted_he> chain. @@ -3357,7 +3357,7 @@ Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags) } /* -=for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags +=for apidoc refcounted_he_fetch_pvn Search along a C<refcounted_he> chain for an entry with the key specified by C<keypv> and C<keylen>. If C<flags> has the C<REFCOUNTED_HE_KEY_UTF8> @@ -3447,7 +3447,7 @@ Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain, } /* -=for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags +=for apidoc refcounted_he_fetch_pv Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string instead of a string/length pair. @@ -3464,7 +3464,7 @@ Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain, } /* -=for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags +=for apidoc refcounted_he_fetch_sv Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a string/length pair. @@ -3491,7 +3491,7 @@ Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain, } /* -=for apidoc m|struct refcounted_he *|refcounted_he_new_pvn|struct refcounted_he *parent|const char *keypv|STRLEN keylen|U32 hash|SV *value|U32 flags +=for apidoc refcounted_he_new_pvn Creates a new C<refcounted_he>. This consists of a single key/value pair and a reference to an existing C<refcounted_he> chain (which may @@ -3635,7 +3635,7 @@ Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent, } /* -=for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags +=for apidoc refcounted_he_new_pv Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead of a string/length pair. @@ -3652,7 +3652,7 @@ Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent, } /* -=for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags +=for apidoc refcounted_he_new_sv Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a string/length pair. @@ -3679,7 +3679,7 @@ Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent, } /* -=for apidoc m|void|refcounted_he_free|struct refcounted_he *he +=for apidoc refcounted_he_free Decrements the reference count of a C<refcounted_he> by one. If the reference count reaches zero the structure's memory is freed, which @@ -3719,7 +3719,7 @@ Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) { } /* -=for apidoc m|struct refcounted_he *|refcounted_he_inc|struct refcounted_he *he +=for apidoc refcounted_he_inc Increment the reference count of a C<refcounted_he>. The pointer to the C<refcounted_he> is also returned. It is safe to pass a null pointer @@ -1013,7 +1013,7 @@ Perl_is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el) /* -=for apidoc Am|STRLEN|isUTF8_CHAR|const U8 *s|const U8 *e +=for apidoc isUTF8_CHAR Evaluates to non-zero if the first few bytes of the string starting at C<s> and looking no further than S<C<e - 1>> are well-formed UTF-8, as extended by Perl, @@ -1156,7 +1156,7 @@ S_isSTRICT_UTF8_CHAR(const U8 * const s0, const U8 * const e) /* -=for apidoc Am|STRLEN|isC9_STRICT_UTF8_CHAR|const U8 *s|const U8 *e +=for apidoc isC9_STRICT_UTF8_CHAR Evaluates to non-zero if the first few bytes of the string starting at C<s> and looking no further than S<C<e - 1>> are well-formed UTF-8 that represents some @@ -1847,7 +1847,7 @@ S_utf8n_to_uvchr_msgs(const U8 *s, /* =head1 Miscellaneous Functions -=for apidoc AiR|bool|is_safe_syscall|const char *pv|STRLEN len|const char *what|const char *op_name +=for apidoc is_safe_syscall Test that the given C<pv> doesn't contain any internal C<NUL> characters. If it does, set C<errno> to C<ENOENT>, optionally warn, and return FALSE. @@ -1729,7 +1729,7 @@ Perl_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen) } /* -=for apidoc Am|HV *|pad_compname_type|PADOFFSET po +=for apidoc pad_compname_type Looks up the type of the lexical variable at position C<po> in the currently-compiling pad. If the variable is typed, the stash of the @@ -600,7 +600,7 @@ Perl_mg_free(pTHX_ SV *sv) } /* -=for apidoc Am|void|mg_free_type|SV *sv|int how +=for apidoc mg_free_type Remove any magic of type C<how> from the SV C<sv>. See L</sv_magic>. @@ -851,7 +851,7 @@ S_fixup_errno_string(pTHX_ SV* sv) } /* -=for apidoc Am|SV *|sv_string_from_errnum|int errnum|SV *tgtsv +=for apidoc sv_string_from_errnum Generates the message string describing an OS error and returns it as an SV. C<errnum> must be a value that C<errno> could take, identifying @@ -805,7 +805,7 @@ S_op_destroy(pTHX_ OP *o) /* Destructor */ /* -=for apidoc Am|void|op_free|OP *o +=for apidoc op_free Free an op. Only use this when an op is no longer linked to from any optree. @@ -1323,7 +1323,7 @@ S_find_and_forget_pmops(pTHX_ OP *o) } /* -=for apidoc Am|void|op_null|OP *o +=for apidoc op_null Neutralizes an op when it is no longer needed, but is still linked to from other ops. @@ -1593,7 +1593,7 @@ Perl_alloc_LOGOP(pTHX_ I32 type, OP *first, OP* other) /* Contextualizers */ /* -=for apidoc Am|OP *|op_contextualize|OP *o|I32 context +=for apidoc op_contextualize Applies a syntactic context to an op tree representing an expression. C<o> is the op tree, and C<context> must be C<G_SCALAR>, C<G_ARRAY>, @@ -1619,7 +1619,7 @@ Perl_op_contextualize(pTHX_ OP *o, I32 context) /* -=for apidoc Am|OP*|op_linklist|OP *o +=for apidoc op_linklist This function is the implementation of the L</LINKLIST> macro. It should not be called directly. @@ -3587,7 +3587,7 @@ S_op_relocate_sv(pTHX_ SV** svp, PADOFFSET* targp) #endif /* -=for apidoc s|OP*|traverse_op_tree|OP* top|OP* o +=for apidoc traverse_op_tree Return the next op in a depth-first traversal of the op tree, returning NULL when the traversal is complete. @@ -3800,7 +3800,7 @@ S_finalize_op(pTHX_ OP* o) } /* -=for apidoc Amx|OP *|op_lvalue|OP *o|I32 type +=for apidoc op_lvalue Propagate lvalue ("modifiable") context to an op and its children. C<type> represents the context type, roughly based on the type of op that @@ -5135,7 +5135,7 @@ Perl_invert(pTHX_ OP *o) } /* -=for apidoc Amx|OP *|op_scope|OP *o +=for apidoc op_scope Wraps up an op tree with some additional ops so that at runtime a dynamic scope will be created. The original ops run in the new dynamic scope, @@ -5190,7 +5190,7 @@ Perl_op_unscope(pTHX_ OP *o) } /* -=for apidoc Am|int|block_start|int full +=for apidoc block_start Handles compile-time scope entry. Arranges for hints to be restored on block @@ -5221,7 +5221,7 @@ Perl_block_start(pTHX_ int full) } /* -=for apidoc Am|OP *|block_end|I32 floor|OP *seq +=for apidoc block_end Handles compile-time scope exit. C<floor> is the savestack index returned by @@ -5320,7 +5320,7 @@ Perl_block_end(pTHX_ I32 floor, OP *seq) /* =head1 Compile-time scope hooks -=for apidoc Aox||blockhook_register +=for apidoc blockhook_register Register a set of hooks to be called when the Perl lexical scope changes at compile time. See L<perlguts/"Compile-time scope hooks">. @@ -5860,7 +5860,7 @@ S_gen_constant_list(pTHX_ OP *o) /* List constructors */ /* -=for apidoc Am|OP *|op_append_elem|I32 optype|OP *first|OP *last +=for apidoc op_append_elem Append an item to the list of ops contained directly within a list-type op, returning the lengthened list. C<first> is the list-type op, @@ -5893,7 +5893,7 @@ Perl_op_append_elem(pTHX_ I32 type, OP *first, OP *last) } /* -=for apidoc Am|OP *|op_append_list|I32 optype|OP *first|OP *last +=for apidoc op_append_list Concatenate the lists of ops contained directly within two list-type ops, returning the combined list. C<first> and C<last> are the list-type ops @@ -5931,7 +5931,7 @@ Perl_op_append_list(pTHX_ I32 type, OP *first, OP *last) } /* -=for apidoc Am|OP *|op_prepend_elem|I32 optype|OP *first|OP *last +=for apidoc op_prepend_elem Prepend an item to the list of ops contained directly within a list-type op, returning the lengthened list. C<first> is the op to prepend to the @@ -5969,7 +5969,7 @@ Perl_op_prepend_elem(pTHX_ I32 type, OP *first, OP *last) } /* -=for apidoc Am|OP *|op_convert_list|I32 type|I32 flags|OP *o +=for apidoc op_convert_list Converts C<o> into a list op if it is not one already, and then converts it into the specified C<type>, calling its check function, allocating a target if @@ -6029,7 +6029,7 @@ Perl_op_convert_list(pTHX_ I32 type, I32 flags, OP *o) /* =head1 Optree construction -=for apidoc Am|OP *|newNULLLIST +=for apidoc newNULLLIST Constructs, checks, and returns a new C<stub> op, which represents an empty list expression. @@ -6076,7 +6076,7 @@ S_force_list(pTHX_ OP *o, bool nullit) } /* -=for apidoc Am|OP *|newLISTOP|I32 type|I32 flags|OP *first|OP *last +=for apidoc newLISTOP Constructs, checks, and returns an op of any list type. C<type> is the opcode. C<flags> gives the eight bits of C<op_flags>, except that @@ -6136,7 +6136,7 @@ Perl_newLISTOP(pTHX_ I32 type, I32 flags, OP *first, OP *last) } /* -=for apidoc Am|OP *|newOP|I32 type|I32 flags +=for apidoc newOP Constructs, checks, and returns an op of any base type (any type that has no extra fields). C<type> is the opcode. C<flags> gives the @@ -6176,7 +6176,7 @@ Perl_newOP(pTHX_ I32 type, I32 flags) } /* -=for apidoc Am|OP *|newUNOP|I32 type|I32 flags|OP *first +=for apidoc newUNOP Constructs, checks, and returns an op of any unary type. C<type> is the opcode. C<flags> gives the eight bits of C<op_flags>, except that @@ -6265,7 +6265,7 @@ Perl_newUNOP_AUX(pTHX_ I32 type, I32 flags, OP *first, UNOP_AUX_item *aux) } /* -=for apidoc Am|OP *|newMETHOP|I32 type|I32 flags|OP *first +=for apidoc newMETHOP Constructs, checks, and returns an op of method type with a method name evaluated at runtime. C<type> is the opcode. C<flags> gives the eight @@ -6322,7 +6322,7 @@ Perl_newMETHOP (pTHX_ I32 type, I32 flags, OP* dynamic_meth) { } /* -=for apidoc Am|OP *|newMETHOP_named|I32 type|I32 flags|SV *const_meth +=for apidoc newMETHOP_named Constructs, checks, and returns an op of method type with a constant method name. C<type> is the opcode. C<flags> gives the eight bits of @@ -6341,7 +6341,7 @@ Perl_newMETHOP_named (pTHX_ I32 type, I32 flags, SV* const_meth) { } /* -=for apidoc Am|OP *|newBINOP|I32 type|I32 flags|OP *first|OP *last +=for apidoc newBINOP Constructs, checks, and returns an op of any binary type. C<type> is the opcode. C<flags> gives the eight bits of C<op_flags>, except @@ -6844,7 +6844,7 @@ S_pmtrans(pTHX_ OP *o, OP *expr, OP *repl) /* -=for apidoc Am|OP *|newPMOP|I32 type|I32 flags +=for apidoc newPMOP Constructs, checks, and returns an op of any pattern matching type. C<type> is the opcode. C<flags> gives the eight bits of C<op_flags> @@ -7328,7 +7328,7 @@ Perl_pmruntime(pTHX_ OP *o, OP *expr, OP *repl, UV flags, I32 floor) } /* -=for apidoc Am|OP *|newSVOP|I32 type|I32 flags|SV *sv +=for apidoc newSVOP Constructs, checks, and returns an op of any type that involves an embedded SV. C<type> is the opcode. C<flags> gives the eight bits @@ -7365,7 +7365,7 @@ Perl_newSVOP(pTHX_ I32 type, I32 flags, SV *sv) } /* -=for apidoc Am|OP *|newDEFSVOP| +=for apidoc newDEFSVOP Constructs and returns an op to access C<$_>. @@ -7381,7 +7381,7 @@ Perl_newDEFSVOP(pTHX) #ifdef USE_ITHREADS /* -=for apidoc Am|OP *|newPADOP|I32 type|I32 flags|SV *sv +=for apidoc newPADOP Constructs, checks, and returns an op of any type that involves a reference to a pad element. C<type> is the opcode. C<flags> gives the @@ -7426,7 +7426,7 @@ Perl_newPADOP(pTHX_ I32 type, I32 flags, SV *sv) #endif /* USE_ITHREADS */ /* -=for apidoc Am|OP *|newGVOP|I32 type|I32 flags|GV *gv +=for apidoc newGVOP Constructs, checks, and returns an op of any type that involves an embedded reference to a GV. C<type> is the opcode. C<flags> gives the @@ -7450,7 +7450,7 @@ Perl_newGVOP(pTHX_ I32 type, I32 flags, GV *gv) } /* -=for apidoc Am|OP *|newPVOP|I32 type|I32 flags|char *pv +=for apidoc newPVOP Constructs, checks, and returns an op of any type that involves an embedded C-level pointer (PV). C<type> is the opcode. C<flags> gives @@ -7785,7 +7785,7 @@ Perl_dofile(pTHX_ OP *term, I32 force_builtin) /* =head1 Optree construction -=for apidoc Am|OP *|newSLICEOP|I32 flags|OP *subscript|OP *listval +=for apidoc newSLICEOP Constructs, checks, and returns an C<lslice> (list slice) op. C<flags> gives the eight bits of C<op_flags>, except that C<OPf_KIDS> will @@ -7899,7 +7899,7 @@ S_newONCEOP(pTHX_ OP *initop, OP *padop) } /* -=for apidoc Am|OP *|newASSIGNOP|I32 flags|OP *left|I32 optype|OP *right +=for apidoc newASSIGNOP Constructs, checks, and returns an assignment op. C<left> and C<right> supply the parameters of the assignment; they are consumed by this @@ -8116,7 +8116,7 @@ Perl_newASSIGNOP(pTHX_ I32 flags, OP *left, I32 optype, OP *right) } /* -=for apidoc Am|OP *|newSTATEOP|I32 flags|char *label|OP *o +=for apidoc newSTATEOP Constructs a state op (COP). The state op is normally a C<nextstate> op, but will be a C<dbstate> op if debugging is enabled for currently-compiled @@ -8207,7 +8207,7 @@ Perl_newSTATEOP(pTHX_ I32 flags, char *label, OP *o) } /* -=for apidoc Am|OP *|newLOGOP|I32 type|I32 flags|OP *first|OP *other +=for apidoc newLOGOP Constructs, checks, and returns a logical (flow control) op. C<type> is the opcode. C<flags> gives the eight bits of C<op_flags>, except @@ -8470,7 +8470,7 @@ S_new_logop(pTHX_ I32 type, I32 flags, OP** firstp, OP** otherp) } /* -=for apidoc Am|OP *|newCONDOP|I32 flags|OP *first|OP *trueop|OP *falseop +=for apidoc newCONDOP Constructs, checks, and returns a conditional-expression (C<cond_expr>) op. C<flags> gives the eight bits of C<op_flags>, except that C<OPf_KIDS> @@ -8545,7 +8545,7 @@ Perl_newCONDOP(pTHX_ I32 flags, OP *first, OP *trueop, OP *falseop) } /* -=for apidoc Am|OP *|newRANGE|I32 flags|OP *left|OP *right +=for apidoc newRANGE Constructs and returns a C<range> op, with subordinate C<flip> and C<flop> ops. C<flags> gives the eight bits of C<op_flags> for the @@ -8612,7 +8612,7 @@ Perl_newRANGE(pTHX_ I32 flags, OP *left, OP *right) } /* -=for apidoc Am|OP *|newLOOPOP|I32 flags|I32 debuggable|OP *expr|OP *block +=for apidoc newLOOPOP Constructs, checks, and returns an op tree expressing a loop. This is only a loop in the control flow through the op tree; it does not have @@ -8713,7 +8713,7 @@ Perl_newLOOPOP(pTHX_ I32 flags, I32 debuggable, OP *expr, OP *block) } /* -=for apidoc Am|OP *|newWHILEOP|I32 flags|I32 debuggable|LOOP *loop|OP *expr|OP *block|OP *cont|I32 has_my +=for apidoc newWHILEOP Constructs, checks, and returns an op tree expressing a C<while> loop. This is a heavyweight loop, with structure that allows exiting the loop @@ -8839,7 +8839,7 @@ Perl_newWHILEOP(pTHX_ I32 flags, I32 debuggable, LOOP *loop, } /* -=for apidoc Am|OP *|newFOROP|I32 flags|OP *sv|OP *expr|OP *block|OP *cont +=for apidoc newFOROP Constructs, checks, and returns an op tree expressing a C<foreach> loop (iteration through a list of values). This is a heavyweight loop, @@ -8980,7 +8980,7 @@ Perl_newFOROP(pTHX_ I32 flags, OP *sv, OP *expr, OP *block, OP *cont) } /* -=for apidoc Am|OP *|newLOOPEX|I32 type|OP *label +=for apidoc newLOOPEX Constructs, checks, and returns a loop-exiting op (such as C<goto> or C<last>). C<type> is the opcode. C<label> supplies the parameter @@ -9209,7 +9209,7 @@ S_looks_like_bool(pTHX_ const OP *o) } /* -=for apidoc Am|OP *|newGIVENOP|OP *cond|OP *block|PADOFFSET defsv_off +=for apidoc newGIVENOP Constructs, checks, and returns an op tree expressing a C<given> block. C<cond> supplies the expression to whose value C<$_> will be locally @@ -9235,7 +9235,7 @@ Perl_newGIVENOP(pTHX_ OP *cond, OP *block, PADOFFSET defsv_off) } /* -=for apidoc Am|OP *|newWHENOP|OP *cond|OP *block +=for apidoc newWHENOP Constructs, checks, and returns an op tree expressing a C<when> block. C<cond> supplies the test expression, and C<block> supplies the block @@ -9853,7 +9853,7 @@ Perl_newMYSUB(pTHX_ I32 floor, OP *o, OP *proto, OP *attrs, OP *block) } /* -=for apidoc m|CV *|newATTRSUB_x|I32 floor|OP *o|OP *proto|OP *attrs|OP *block|bool o_is_gv +=for apidoc newATTRSUB_x Construct a Perl subroutine, also performing some surrounding jobs. @@ -10518,7 +10518,7 @@ S_process_special_blocks(pTHX_ I32 floor, const char *const fullname, } /* -=for apidoc Am|CV *|newCONSTSUB|HV *stash|const char *name|SV *sv +=for apidoc newCONSTSUB Behaves like L</newCONSTSUB_flags>, except that C<name> is nul-terminated rather than of counted length, and no flags are set. (This means that @@ -10534,7 +10534,7 @@ Perl_newCONSTSUB(pTHX_ HV *stash, const char *name, SV *sv) } /* -=for apidoc Am|CV *|newCONSTSUB_flags|HV *stash|const char *name|STRLEN len|U32 flags|SV *sv +=for apidoc newCONSTSUB_flags Construct a constant subroutine, also performing some surrounding jobs. A scalar constant-valued subroutine is eligible for inlining @@ -10656,7 +10656,7 @@ Perl_newCONSTSUB_flags(pTHX_ HV *stash, const char *name, STRLEN len, } /* -=for apidoc U||newXS +=for apidoc newXS Used by C<xsubpp> to hook up XSUBs as Perl subs. C<filename> needs to be static storage, as it is used directly as CvFILE(), without a copy being made. @@ -10694,7 +10694,7 @@ Perl_newXS_deffile(pTHX_ const char *name, XSUBADDR_t subaddr) } /* -=for apidoc m|CV *|newXS_len_flags|const char *name|STRLEN len|XSUBADDR_t subaddr|const char *const filename|const char *const proto|SV **const_svp|U32 flags +=for apidoc newXS_len_flags Construct an XS subroutine, also performing some surrounding jobs. @@ -13013,7 +13013,7 @@ Perl_ck_join(pTHX_ OP *o) } /* -=for apidoc Am|CV *|rv2cv_op_cv|OP *cvop|U32 flags +=for apidoc rv2cv_op_cv Examines an op, which is expected to identify a subroutine at runtime, and attempts to determine at compile time which subroutine it identifies. @@ -13141,7 +13141,7 @@ Perl_rv2cv_op_cv(pTHX_ OP *cvop, U32 flags) } /* -=for apidoc Am|OP *|ck_entersub_args_list|OP *entersubop +=for apidoc ck_entersub_args_list Performs the default fixup of the arguments part of an C<entersub> op tree. This consists of applying list context to each of the @@ -13178,7 +13178,7 @@ Perl_ck_entersub_args_list(pTHX_ OP *entersubop) } /* -=for apidoc Am|OP *|ck_entersub_args_proto|OP *entersubop|GV *namegv|SV *protosv +=for apidoc ck_entersub_args_proto Performs the fixup of the arguments part of an C<entersub> op tree based on a subroutine prototype. This makes various modifications to @@ -13426,7 +13426,7 @@ Perl_ck_entersub_args_proto(pTHX_ OP *entersubop, GV *namegv, SV *protosv) } /* -=for apidoc Am|OP *|ck_entersub_args_proto_or_list|OP *entersubop|GV *namegv|SV *protosv +=for apidoc ck_entersub_args_proto_or_list Performs the fixup of the arguments part of an C<entersub> op tree either based on a subroutine prototype or using default list-context processing. @@ -13578,7 +13578,7 @@ Perl_ck_entersub_args_core(pTHX_ OP *entersubop, GV *namegv, SV *protosv) } /* -=for apidoc Am|void|cv_get_call_checker_flags|CV *cv|U32 gflags|Perl_call_checker *ckfun_p|SV **ckobj_p|U32 *ckflags_p +=for apidoc cv_get_call_checker_flags Retrieves the function that will be used to fix up a call to C<cv>. Specifically, the function is applied to an C<entersub> op tree for a @@ -13624,7 +13624,7 @@ C<gflags> is a bitset passed into C<cv_get_call_checker_flags>, in which only the C<CALL_CHECKER_REQUIRE_GV> bit currently has a defined meaning (for which see above). All other bits should be clear. -=for apidoc Am|void|cv_get_call_checker|CV *cv|Perl_call_checker *ckfun_p|SV **ckobj_p +=for apidoc cv_get_call_checker The original form of L</cv_get_call_checker_flags>, which does not return checker flags. When using a checker function returned by this function, @@ -13663,7 +13663,7 @@ Perl_cv_get_call_checker(pTHX_ CV *cv, Perl_call_checker *ckfun_p, SV **ckobj_p) } /* -=for apidoc Am|void|cv_set_call_checker_flags|CV *cv|Perl_call_checker ckfun|SV *ckobj|U32 ckflags +=for apidoc cv_set_call_checker_flags Sets the function that will be used to fix up a call to C<cv>. Specifically, the function is applied to an C<entersub> op tree for a @@ -13699,7 +13699,7 @@ bits should be clear. The current setting for a particular CV can be retrieved by L</cv_get_call_checker_flags>. -=for apidoc Am|void|cv_set_call_checker|CV *cv|Perl_call_checker ckfun|SV *ckobj +=for apidoc cv_set_call_checker The original form of L</cv_set_call_checker_flags>, which passes it the C<CALL_CHECKER_REQUIRE_GV> flag for backward-compatibility. The effect @@ -16647,7 +16647,7 @@ Perl_peep(pTHX_ OP *o) /* =head1 Custom Operators -=for apidoc Ao||custom_op_xop +=for apidoc custom_op_xop Return the XOP structure for a given custom op. This macro should be considered internal to C<OP_NAME> and the other access macros: use them instead. This macro does call a function. Prior @@ -16804,7 +16804,7 @@ Perl_custom_op_get_field(pTHX_ const OP *o, const xop_flags_enum field) } /* -=for apidoc Ao||custom_op_register +=for apidoc custom_op_register Register a custom op. See L<perlguts/"Custom Operators">. =cut @@ -17058,7 +17058,7 @@ hook variables. */ /* -=for apidoc Am|void|wrap_op_checker|Optype opcode|Perl_check_t new_checker|Perl_check_t *old_checker_p +=for apidoc wrap_op_checker Puts a C function into the chain of check functions for a specified op type. This is the preferred way to manipulate the L</PL_check> array. @@ -173,7 +173,7 @@ Perl_set_padlist(CV * cv, PADLIST *padlist){ #endif /* -=for apidoc Am|PADLIST *|pad_new|int flags +=for apidoc pad_new Create a new padlist, updating the global variables for the currently-compiling padlist to point to the new padlist. The following @@ -516,7 +516,7 @@ Perl_cv_forget_slab(pTHX_ CV *cv) } /* -=for apidoc m|PADOFFSET|pad_alloc_name|PADNAME *name|U32 flags|HV *typestash|HV *ourstash +=for apidoc pad_alloc_name Allocates a place in the currently-compiling pad (via L<perlapi/pad_alloc>) and @@ -561,7 +561,7 @@ S_pad_alloc_name(pTHX_ PADNAME *name, U32 flags, HV *typestash, } /* -=for apidoc Am|PADOFFSET|pad_add_name_pvn|const char *namepv|STRLEN namelen|U32 flags|HV *typestash|HV *ourstash +=for apidoc pad_add_name_pvn Allocates a place in the currently-compiling pad for a named lexical variable. Stores the name and other metadata in the name part of the @@ -633,7 +633,7 @@ Perl_pad_add_name_pvn(pTHX_ const char *namepv, STRLEN namelen, } /* -=for apidoc Am|PADOFFSET|pad_add_name_pv|const char *name|U32 flags|HV *typestash|HV *ourstash +=for apidoc pad_add_name_pv Exactly like L</pad_add_name_pvn>, but takes a nul-terminated string instead of a string/length pair. @@ -650,7 +650,7 @@ Perl_pad_add_name_pv(pTHX_ const char *name, } /* -=for apidoc Am|PADOFFSET|pad_add_name_sv|SV *name|U32 flags|HV *typestash|HV *ourstash +=for apidoc pad_add_name_sv Exactly like L</pad_add_name_pvn>, but takes the name string in the form of an SV instead of a string/length pair. @@ -669,7 +669,7 @@ Perl_pad_add_name_sv(pTHX_ SV *name, U32 flags, HV *typestash, HV *ourstash) } /* -=for apidoc Amx|PADOFFSET|pad_alloc|I32 optype|U32 tmptype +=for apidoc pad_alloc Allocates a place in the currently-compiling pad, returning the offset of the allocated pad slot. @@ -769,7 +769,7 @@ Perl_pad_alloc(pTHX_ I32 optype, U32 tmptype) } /* -=for apidoc Am|PADOFFSET|pad_add_anon|CV *func|I32 optype +=for apidoc pad_add_anon Allocates a place in the currently-compiling pad (via L</pad_alloc>) for an anonymous function that is lexically scoped inside the @@ -917,7 +917,7 @@ S_pad_check_dup(pTHX_ PADNAME *name, U32 flags, const HV *ourstash) /* -=for apidoc Am|PADOFFSET|pad_findmy_pvn|const char *namepv|STRLEN namelen|U32 flags +=for apidoc pad_findmy_pvn Given the name of a lexical variable, find its position in the currently-compiling pad. @@ -982,7 +982,7 @@ Perl_pad_findmy_pvn(pTHX_ const char *namepv, STRLEN namelen, U32 flags) } /* -=for apidoc Am|PADOFFSET|pad_findmy_pv|const char *name|U32 flags +=for apidoc pad_findmy_pv Exactly like L</pad_findmy_pvn>, but takes a nul-terminated string instead of a string/length pair. @@ -998,7 +998,7 @@ Perl_pad_findmy_pv(pTHX_ const char *name, U32 flags) } /* -=for apidoc Am|PADOFFSET|pad_findmy_sv|SV *name|U32 flags +=for apidoc pad_findmy_sv Exactly like L</pad_findmy_pvn>, but takes the name string in the form of an SV instead of a string/length pair. @@ -1017,7 +1017,7 @@ Perl_pad_findmy_sv(pTHX_ SV *name, U32 flags) } /* -=for apidoc Amp|PADOFFSET|find_rundefsvoffset +=for apidoc find_rundefsvoffset Until the lexical C<$_> feature was removed, this function would find the position of the lexical C<$_> in the pad of the @@ -1037,7 +1037,7 @@ Perl_find_rundefsvoffset(pTHX) } /* -=for apidoc Am|SV *|find_rundefsv +=for apidoc find_rundefsv Returns the global variable C<$_>. @@ -1051,7 +1051,7 @@ Perl_find_rundefsv(pTHX) } /* -=for apidoc m|PADOFFSET|pad_findlex|const char *namepv|STRLEN namelen|U32 flags|const CV* cv|U32 seq|int warn|SV** out_capture|PADNAME** out_name|int *out_flags +=for apidoc pad_findlex Find a named lexical anywhere in a chain of nested pads. Add fake entries in the inner pads if it's found in an outer one. @@ -1334,7 +1334,7 @@ S_pad_findlex(pTHX_ const char *namepv, STRLEN namelen, U32 flags, const CV* cv, #ifdef DEBUGGING /* -=for apidoc Am|SV *|pad_sv|PADOFFSET po +=for apidoc pad_sv Get the value at offset C<po> in the current (compiling or executing) pad. Use macro C<PAD_SV> instead of calling this function directly. @@ -1357,7 +1357,7 @@ Perl_pad_sv(pTHX_ PADOFFSET po) } /* -=for apidoc Am|void|pad_setsv|PADOFFSET po|SV *sv +=for apidoc pad_setsv Set the value at offset C<po> in the current (compiling or executing) pad. Use the macro C<PAD_SETSV()> rather than calling this function directly. @@ -1382,7 +1382,7 @@ Perl_pad_setsv(pTHX_ PADOFFSET po, SV* sv) #endif /* DEBUGGING */ /* -=for apidoc m|void|pad_block_start|int full +=for apidoc pad_block_start Update the pad compilation state variables on entry to a new block. @@ -1415,7 +1415,7 @@ Perl_pad_block_start(pTHX_ int full) } /* -=for apidoc Am|U32|intro_my +=for apidoc intro_my "Introduce" C<my> variables to visible status. This is called during parsing at the end of each statement to make lexical variables visible to subsequent @@ -1468,7 +1468,7 @@ Perl_intro_my(pTHX) } /* -=for apidoc m|void|pad_leavemy +=for apidoc pad_leavemy Cleanup at end of scope during compilation: set the max seq number for lexicals in this scope and warn of any lexicals that never got introduced. @@ -1524,7 +1524,7 @@ Perl_pad_leavemy(pTHX) } /* -=for apidoc m|void|pad_swipe|PADOFFSET po|bool refadjust +=for apidoc pad_swipe Abandon the tmp in the current pad at offset C<po> and replace with a new one. @@ -1576,7 +1576,7 @@ Perl_pad_swipe(pTHX_ PADOFFSET po, bool refadjust) } /* -=for apidoc m|void|pad_reset +=for apidoc pad_reset Mark all the current temporaries for reuse @@ -1611,7 +1611,7 @@ S_pad_reset(pTHX) } /* -=for apidoc Amx|void|pad_tidy|padtidy_type type +=for apidoc pad_tidy Tidy up a pad at the end of compilation of the code to which it belongs. Jobs performed here are: remove most stuff from the pads of anonsub @@ -1729,7 +1729,7 @@ Perl_pad_tidy(pTHX_ padtidy_type type) } /* -=for apidoc m|void|pad_free|PADOFFSET po +=for apidoc pad_free Free the SV at offset po in the current pad. @@ -1767,7 +1767,7 @@ Perl_pad_free(pTHX_ PADOFFSET po) } /* -=for apidoc m|void|do_dump_pad|I32 level|PerlIO *file|PADLIST *padlist|int full +=for apidoc do_dump_pad Dump the contents of a padlist @@ -1839,7 +1839,7 @@ Perl_do_dump_pad(pTHX_ I32 level, PerlIO *file, PADLIST *padlist, int full) #ifdef DEBUGGING /* -=for apidoc m|void|cv_dump|CV *cv|const char *title +=for apidoc cv_dump dump the contents of a CV @@ -1878,7 +1878,7 @@ S_cv_dump(pTHX_ const CV *cv, const char *title) #endif /* DEBUGGING */ /* -=for apidoc Am|CV *|cv_clone|CV *proto +=for apidoc cv_clone Clone a CV, making a lexical closure. C<proto> supplies the prototype of the function: its code, pad structure, and other attributes. @@ -2316,7 +2316,7 @@ Perl_cv_name(pTHX_ CV *cv, SV *sv, U32 flags) } /* -=for apidoc m|void|pad_fixup_inner_anons|PADLIST *padlist|CV *old_cv|CV *new_cv +=for apidoc pad_fixup_inner_anons For any anon CVs in the pad, change C<CvOUTSIDE> of that CV from C<old_cv> to C<new_cv> if necessary. Needed when a newly-compiled CV has to be @@ -2388,7 +2388,7 @@ Perl_pad_fixup_inner_anons(pTHX_ PADLIST *padlist, CV *old_cv, CV *new_cv) } /* -=for apidoc m|void|pad_push|PADLIST *padlist|int depth +=for apidoc pad_push Push a new pad frame onto the padlist, unless there's already a pad at this depth, in which case don't bother creating a new one. Then give @@ -574,7 +574,7 @@ Perl_dump_sv_child(pTHX_ SV *sv) #endif /* -=for apidoc Am|int|perl_destruct|PerlInterpreter *my_perl +=for apidoc perl_destruct Shuts down a Perl interpreter. See L<perlembed> for a tutorial. @@ -1583,7 +1583,7 @@ Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr) } /* -=for apidoc Am|int|perl_parse|PerlInterpreter *my_perl|XSINIT_t xsinit|int argc|char **argv|char **env +=for apidoc perl_parse Tells a Perl interpreter to parse a Perl script. This performs most of the initialisation of a Perl interpreter. See L<perlembed> for @@ -2567,7 +2567,7 @@ S_parse_body(pTHX_ char **env, XSINIT_t xsinit) } /* -=for apidoc Am|int|perl_run|PerlInterpreter *my_perl +=for apidoc perl_run Tells a Perl interpreter to run its main program. See L<perlembed> for a tutorial. @@ -2722,7 +2722,7 @@ S_run_body(pTHX_ I32 oldscope) /* =head1 SV Manipulation Functions -=for apidoc p||get_sv +=for apidoc get_sv Returns the SV of the specified Perl scalar. C<flags> are passed to C<gv_fetchpv>. If C<GV_ADD> is set and the @@ -2748,7 +2748,7 @@ Perl_get_sv(pTHX_ const char *name, I32 flags) /* =head1 Array Manipulation Functions -=for apidoc p||get_av +=for apidoc get_av Returns the AV of the specified Perl global or package array with the given name (so it won't work on lexical variables). C<flags> are passed @@ -2778,7 +2778,7 @@ Perl_get_av(pTHX_ const char *name, I32 flags) /* =head1 Hash Manipulation Functions -=for apidoc p||get_hv +=for apidoc get_hv Returns the HV of the specified Perl hash. C<flags> are passed to C<gv_fetchpv>. If C<GV_ADD> is set and the @@ -2805,7 +2805,7 @@ Perl_get_hv(pTHX_ const char *name, I32 flags) /* =head1 CV Manipulation Functions -=for apidoc p||get_cvn_flags +=for apidoc get_cvn_flags Returns the CV of the specified Perl subroutine. C<flags> are passed to C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not @@ -2813,7 +2813,7 @@ exist then it will be declared (which has the same effect as saying C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist then NULL is returned. -=for apidoc p||get_cv +=for apidoc get_cv Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>. @@ -2857,7 +2857,7 @@ Perl_get_cv(pTHX_ const char *name, I32 flags) =head1 Callback Functions -=for apidoc p||call_argv +=for apidoc call_argv Performs a callback to the specified named and package-scoped Perl subroutine with C<argv> (a C<NULL>-terminated array of strings) as arguments. See @@ -2888,7 +2888,7 @@ Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv) } /* -=for apidoc p||call_pv +=for apidoc call_pv Performs a callback to the specified Perl sub. See L<perlcall>. @@ -2906,7 +2906,7 @@ Perl_call_pv(pTHX_ const char *sub_name, I32 flags) } /* -=for apidoc p||call_method +=for apidoc call_method Performs a callback to the specified Perl method. The blessed object must be on the stack. See L<perlcall>. @@ -2933,7 +2933,7 @@ Perl_call_method(pTHX_ const char *methname, I32 flags) /* May be called with any of a CV, a GV, or an SV containing the name. */ /* -=for apidoc p||call_sv +=for apidoc call_sv Performs a callback to the Perl sub specified by the SV. @@ -3096,7 +3096,7 @@ Perl_call_sv(pTHX_ SV *sv, volatile I32 flags) /* Eval a string. The G_EVAL flag is always assumed. */ /* -=for apidoc p||eval_sv +=for apidoc eval_sv Tells Perl to C<eval> the string in the SV. It supports the same flags as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>. @@ -3204,7 +3204,7 @@ Perl_eval_sv(pTHX_ SV *sv, I32 flags) } /* -=for apidoc p||eval_pv +=for apidoc eval_pv Tells Perl to C<eval> the given string in scalar context and return an SV* result. @@ -3243,7 +3243,7 @@ Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error) /* =head1 Embedding Functions -=for apidoc p||require_pv +=for apidoc require_pv Tells Perl to C<require> the file named by the string argument. It is analogous to the Perl code C<eval "require '$file'">. It's even @@ -666,7 +666,7 @@ S_cr_textfilter(pTHX_ int idx, SV *sv, int maxlen) #endif /* -=for apidoc Amx|void|lex_start|SV *line|PerlIO *rsfp|U32 flags +=for apidoc lex_start Creates and initialises a new lexer/parser state object, supplying a context in which to lex and parse from a new source of Perl code. @@ -895,7 +895,7 @@ a newline; the function L</lex_read_to> handles this detail. */ /* -=for apidoc Amx|bool|lex_bufutf8 +=for apidoc lex_bufutf8 Indicates whether the octets in the lexer buffer (L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding @@ -926,7 +926,7 @@ Perl_lex_bufutf8(pTHX) } /* -=for apidoc Amx|char *|lex_grow_linestr|STRLEN len +=for apidoc lex_grow_linestr Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate at least C<len> octets (including terminating C<NUL>). Returns a @@ -989,7 +989,7 @@ Perl_lex_grow_linestr(pTHX_ STRLEN len) } /* -=for apidoc Amx|void|lex_stuff_pvn|const char *pv|STRLEN len|U32 flags +=for apidoc lex_stuff_pvn Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>), immediately after the current lexing point (L</PL_parser-E<gt>bufptr>), @@ -1084,7 +1084,7 @@ Perl_lex_stuff_pvn(pTHX_ const char *pv, STRLEN len, U32 flags) } /* -=for apidoc Amx|void|lex_stuff_pv|const char *pv|U32 flags +=for apidoc lex_stuff_pv Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>), immediately after the current lexing point (L</PL_parser-E<gt>bufptr>), @@ -1113,7 +1113,7 @@ Perl_lex_stuff_pv(pTHX_ const char *pv, U32 flags) } /* -=for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags +=for apidoc lex_stuff_sv Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>), immediately after the current lexing point (L</PL_parser-E<gt>bufptr>), @@ -1145,7 +1145,7 @@ Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags) } /* -=for apidoc Amx|void|lex_unstuff|char *ptr +=for apidoc lex_unstuff Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to C<ptr>. Text following C<ptr> will be moved, and the buffer shortened. @@ -1179,7 +1179,7 @@ Perl_lex_unstuff(pTHX_ char *ptr) } /* -=for apidoc Amx|void|lex_read_to|char *ptr +=for apidoc lex_read_to Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up to C<ptr>. This advances L</PL_parser-E<gt>bufptr> to match C<ptr>, @@ -1210,7 +1210,7 @@ Perl_lex_read_to(pTHX_ char *ptr) } /* -=for apidoc Amx|void|lex_discard_to|char *ptr +=for apidoc lex_discard_to Discards the first part of the L</PL_parser-E<gt>linestr> buffer, up to C<ptr>. The remaining content of the buffer will be moved, and @@ -1282,7 +1282,7 @@ Perl_notify_parser_that_changed_to_utf8(pTHX) } /* -=for apidoc Amx|bool|lex_next_chunk|U32 flags +=for apidoc lex_next_chunk Reads in the next chunk of text to be lexed, appending it to L</PL_parser-E<gt>linestr>. This should be called when lexing code has @@ -1422,7 +1422,7 @@ Perl_lex_next_chunk(pTHX_ U32 flags) } /* -=for apidoc Amx|I32|lex_peek_unichar|U32 flags +=for apidoc lex_peek_unichar Looks ahead one (Unicode) character in the text currently being lexed. Returns the codepoint (unsigned integer value) of the next character, @@ -1491,7 +1491,7 @@ Perl_lex_peek_unichar(pTHX_ U32 flags) } /* -=for apidoc Amx|I32|lex_read_unichar|U32 flags +=for apidoc lex_read_unichar Reads the next (Unicode) character in the text currently being lexed. Returns the codepoint (unsigned integer value) of the character read, @@ -1529,7 +1529,7 @@ Perl_lex_read_unichar(pTHX_ U32 flags) } /* -=for apidoc Amx|void|lex_read_space|U32 flags +=for apidoc lex_read_space Reads optional spaces, in Perl style, in the text currently being lexed. The spaces may include ordinary whitespace characters and @@ -1604,7 +1604,7 @@ Perl_lex_read_space(pTHX_ U32 flags) /* -=for apidoc EXMp|bool|validate_proto|SV *name|SV *proto|bool warn +=for apidoc validate_proto This function performs syntax checking on a prototype, C<proto>. If C<warn> is true, any illegal characters or mismatched brackets @@ -12268,7 +12268,7 @@ Perl_keyword_plugin_standard(pTHX_ } /* -=for apidoc Amx|void|wrap_keyword_plugin|Perl_keyword_plugin_t new_plugin|Perl_keyword_plugin_t *old_plugin_p +=for apidoc wrap_keyword_plugin Puts a C function into the chain of keyword plugins. This is the preferred way to manipulate the L</PL_keyword_plugin> variable. @@ -12387,7 +12387,7 @@ S_parse_expr(pTHX_ I32 fakeeof, U32 flags) } /* -=for apidoc Amx|OP *|parse_arithexpr|U32 flags +=for apidoc parse_arithexpr Parse a Perl arithmetic expression. This may contain operators of precedence down to the bit shift operators. The expression must be followed (and thus @@ -12419,7 +12419,7 @@ Perl_parse_arithexpr(pTHX_ U32 flags) } /* -=for apidoc Amx|OP *|parse_termexpr|U32 flags +=for apidoc parse_termexpr Parse a Perl term expression. This may contain operators of precedence down to the assignment operators. The expression must be followed (and thus @@ -12451,7 +12451,7 @@ Perl_parse_termexpr(pTHX_ U32 flags) } /* -=for apidoc Amx|OP *|parse_listexpr|U32 flags +=for apidoc parse_listexpr Parse a Perl list expression. This may contain operators of precedence down to the comma operator. The expression must be followed (and thus @@ -12483,7 +12483,7 @@ Perl_parse_listexpr(pTHX_ U32 flags) } /* -=for apidoc Amx|OP *|parse_fullexpr|U32 flags +=for apidoc parse_fullexpr Parse a single complete Perl expression. This allows the full expression grammar, including the lowest-precedence operators such @@ -12516,7 +12516,7 @@ Perl_parse_fullexpr(pTHX_ U32 flags) } /* -=for apidoc Amx|OP *|parse_block|U32 flags +=for apidoc parse_block Parse a single complete Perl code block. This consists of an opening brace, a sequence of statements, and a closing brace. The block @@ -12552,7 +12552,7 @@ Perl_parse_block(pTHX_ U32 flags) } /* -=for apidoc Amx|OP *|parse_barestmt|U32 flags +=for apidoc parse_barestmt Parse a single unadorned Perl statement. This may be a normal imperative statement or a declaration that has compile-time effect. It does not @@ -12590,7 +12590,7 @@ Perl_parse_barestmt(pTHX_ U32 flags) } /* -=for apidoc Amx|SV *|parse_label|U32 flags +=for apidoc parse_label Parse a single label, possibly optional, of the type that may prefix a Perl statement. It is up to the caller to ensure that the dynamic parser @@ -12660,7 +12660,7 @@ Perl_parse_label(pTHX_ U32 flags) } /* -=for apidoc Amx|OP *|parse_fullstmt|U32 flags +=for apidoc parse_fullstmt Parse a single complete Perl statement. This may be a normal imperative statement or a declaration that has compile-time effect, and may include @@ -12695,7 +12695,7 @@ Perl_parse_fullstmt(pTHX_ U32 flags) } /* -=for apidoc Amx|OP *|parse_stmtseq|U32 flags +=for apidoc parse_stmtseq Parse a sequence of zero or more Perl statements. These may be normal imperative statements, including optional labels, or declarations @@ -591,7 +591,7 @@ Perl_delimcpy_no_escape(char *to, const char *toend, const char *from, /* =head1 Miscellaneous Functions -=for apidoc Am|char *|ninstr|char * big|char * bigend|char * little|char * little_end +=for apidoc ninstr Find the first (leftmost) occurrence of a sequence of bytes within another sequence. This is the Perl version of C<strstr()>, extended to handle @@ -652,7 +652,7 @@ Perl_ninstr(const char *big, const char *bigend, const char *little, const char /* =head1 Miscellaneous Functions -=for apidoc Am|char *|rninstr|char * big|char * bigend|char * little|char * little_end +=for apidoc rninstr Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a sequence of bytes within another sequence, returning C<NULL> if there is no @@ -1287,7 +1287,7 @@ Perl_vform(pTHX_ const char *pat, va_list *args) } /* -=for apidoc Am|SV *|mess|const char *pat|... +=for apidoc mess Take a sprintf-style format pattern and argument list. These are used to generate a string message. If the message does not end with a newline, @@ -1368,7 +1368,7 @@ Perl_closest_cop(pTHX_ const COP *cop, const OP *o, const OP *curop, } /* -=for apidoc Am|SV *|mess_sv|SV *basemsg|bool consume +=for apidoc mess_sv Expands a message, intended for the user, to include an indication of the current location in the code, if the message does not already appear @@ -1472,7 +1472,7 @@ Perl_mess_sv(pTHX_ SV *basemsg, bool consume) } /* -=for apidoc Am|SV *|vmess|const char *pat|va_list *args +=for apidoc vmess C<pat> and C<args> are a sprintf-style format pattern and encapsulated argument list, respectively. These are used to generate a string message. If @@ -1584,7 +1584,7 @@ S_invoke_exception_hook(pTHX_ SV *ex, bool warn) } /* -=for apidoc Am|OP *|die_sv|SV *baseex +=for apidoc die_sv Behaves the same as L</croak_sv>, except for the return type. It should be used only where the C<OP *> return type is required. @@ -1606,7 +1606,7 @@ Perl_die_sv(pTHX_ SV *baseex) MSVC_DIAG_RESTORE /* -=for apidoc Am|OP *|die|const char *pat|... +=for apidoc die Behaves the same as L</croak>, except for the return type. It should be used only where the C<OP *> return type is required. @@ -1649,7 +1649,7 @@ Perl_die(pTHX_ const char* pat, ...) MSVC_DIAG_RESTORE /* -=for apidoc Am|void|croak_sv|SV *baseex +=for apidoc croak_sv This is an XS interface to Perl's C<die> function. @@ -1679,7 +1679,7 @@ Perl_croak_sv(pTHX_ SV *baseex) } /* -=for apidoc Am|void|vcroak|const char *pat|va_list *args +=for apidoc vcroak This is an XS interface to Perl's C<die> function. @@ -1712,7 +1712,7 @@ Perl_vcroak(pTHX_ const char* pat, va_list *args) } /* -=for apidoc Am|void|croak|const char *pat|... +=for apidoc croak This is an XS interface to Perl's C<die> function. @@ -1759,7 +1759,7 @@ Perl_croak(pTHX_ const char *pat, ...) } /* -=for apidoc Am|void|croak_no_modify +=for apidoc croak_no_modify Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates terser object code than using C<Perl_croak>. Less code used on exception code @@ -1802,7 +1802,7 @@ Perl_croak_popstack(void) } /* -=for apidoc Am|void|warn_sv|SV *baseex +=for apidoc warn_sv This is an XS interface to Perl's C<warn> function. @@ -1830,7 +1830,7 @@ Perl_warn_sv(pTHX_ SV *baseex) } /* -=for apidoc Am|void|vwarn|const char *pat|va_list *args +=for apidoc vwarn This is an XS interface to Perl's C<warn> function. @@ -1858,7 +1858,7 @@ Perl_vwarn(pTHX_ const char* pat, va_list *args) } /* -=for apidoc Am|void|warn|const char *pat|... +=for apidoc warn This is an XS interface to Perl's C<warn> function. |