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 /pad.c | |
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.
Diffstat (limited to 'pad.c')
-rw-r--r-- | pad.c | 54 |
1 files changed, 27 insertions, 27 deletions
@@ -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 |