diff options
author | Karl Williamson <khw@cpan.org> | 2020-07-18 07:24:34 -0600 |
---|---|---|
committer | Karl Williamson <khw@cpan.org> | 2020-08-23 22:22:00 -0600 |
commit | 3d12c2383c597cf1010d322c29f82b0e6782d327 (patch) | |
tree | 86722373de723e5678439cf19147f024f75261f5 /util.c | |
parent | 4d4f193c8e0e9e39cf47694e174e7f954c2faa63 (diff) | |
download | perl-3d12c2383c597cf1010d322c29f82b0e6782d327.tar.gz |
Document a bunch of foo_nocontext functions
These just refer to foo's pod, with an explanation of 'nocontext'
Diffstat (limited to 'util.c')
-rw-r--r-- | util.c | 29 |
1 files changed, 27 insertions, 2 deletions
@@ -1174,7 +1174,7 @@ string which is a duplicate of C<pv>. The size of the string is determined by C<strlen()>, which means it may not contain embedded C<NUL> characters and must have a trailing C<NUL>. To prevent memory leaks, the memory allocated for the new string needs to be freed when no longer needed. -This can be done with the L</C<Safefree>> function, or +This can be done with the C<L</Safefree>> function, or L<C<SAVEFREEPV>|perlguts/SAVEFREEPV(p)>. On some platforms, Windows for example, all allocated memory owned by a thread @@ -1389,6 +1389,11 @@ Uses a single private buffer so if you want to format several strings you must explicitly copy the earlier strings away (and free the copies when you are done). +=for apidoc form_nocontext +Like C<L</form>> but does not take a thread context (C<aTHX>) parameter, +so is used in situations where the caller doesn't already have the thread +context. + =cut */ @@ -1425,6 +1430,11 @@ Normally, the resulting message is returned in a new mortal SV. During global destruction a single SV may be shared between uses of this function. +=for apidoc mess_nocontext +Like C<L</mess>> but does not take a thread context (C<aTHX>) parameter, +so is used in situations where the caller doesn't already have the thread +context. + =cut */ @@ -1716,6 +1726,11 @@ 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. The function never actually returns. +=for apidoc die_nocontext +Like C<L</die>> but does not take a thread context (C<aTHX>) parameter, +so is used in situations where the caller doesn't already have the thread +context. + =cut */ @@ -1826,6 +1841,11 @@ error message from arguments. If you want to throw a non-string object, or build an error message in an SV yourself, it is preferable to use the L</croak_sv> function, which does not involve clobbering C<ERRSV>. +=for apidoc croak_nocontext +Like C<L</croak>> but does not take a thread context (C<aTHX>) parameter, +so is used in situations where the caller doesn't already have the thread +context. + =cut */ @@ -1969,7 +1989,7 @@ Perl_warn_sv(pTHX_ SV *baseex) This is an XS interface to Perl's C<warn> function. -This is like L</C<warn>>, but C<args> are an encapsulated +This is like C<L</warn>>, but C<args> are an encapsulated argument list. Unlike with L</vcroak>, C<pat> is not permitted to be null. @@ -2001,6 +2021,11 @@ but this is subject to modification by a C<$SIG{__WARN__}> handler. Unlike with L</croak>, C<pat> is not permitted to be null. +=for apidoc warn_nocontext +Like C<L</warn>> but does not take a thread context (C<aTHX>) parameter, +so is used in situations where the caller doesn't already have the thread +context. + =cut */ |