summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2022-05-19 12:35:35 -0600
committerKarl Williamson <khw@cpan.org>2022-05-20 14:59:09 -0600
commitee85153c5be6c687c46b7b967ecb852c44341f03 (patch)
treef8ba2f39d15a1f72bb01c4a1fe0e09c98c16fdde
parente8c6e1955ee87066678ecec00f47283dbd1e1ca7 (diff)
downloadperl-ee85153c5be6c687c46b7b967ecb852c44341f03.tar.gz
perlapi: Document do_sprintf
-rw-r--r--doop.c16
-rw-r--r--embed.fnc2
2 files changed, 17 insertions, 1 deletions
diff --git a/doop.c b/doop.c
index ede537723c..025d1d8086 100644
--- a/doop.c
+++ b/doop.c
@@ -701,6 +701,22 @@ Perl_do_join(pTHX_ SV *sv, SV *delim, SV **mark, SV **sp)
SvSETMAGIC(sv);
}
+/*
+=for apidoc_section $string
+=for apidoc do_sprintf
+
+This performs a Perl L<C<sprintf>|perlfunc/sprintf> placing the string output
+into C<sv>.
+
+The elements to format are in SVs, stored in a C array of pointers to SVs of
+length C<len>> and beginning at C<**sarg>. The element referenced by C<*sarg>
+is the format.
+
+Magic and tainting are handled.
+
+=cut
+*/
+
void
Perl_do_sprintf(pTHX_ SV *sv, SSize_t len, SV **sarg)
{
diff --git a/embed.fnc b/embed.fnc
index cd37f58db7..7b03dc5bfc 100644
--- a/embed.fnc
+++ b/embed.fnc
@@ -883,7 +883,7 @@ p |bool |do_print |NULLOK SV* sv|NN PerlIO* fp
pR |OP* |do_readline
: Defined in doio.c, used only in pp_sys.c
p |bool |do_seek |NULLOK GV* gv|Off_t pos|int whence
-Ap |void |do_sprintf |NN SV* sv|SSize_t len|NN SV** sarg
+Apd |void |do_sprintf |NN SV* sv|SSize_t len|NN SV** sarg
: Defined in doio.c, used only in pp_sys.c
p |Off_t |do_sysseek |NN GV* gv|Off_t pos|int whence
: Defined in doio.c, used only in pp_sys.c