From 8871d594618331758886dd6263c0ac25616e9ba3 Mon Sep 17 00:00:00 2001
From: Karl Williamson <khw@cpan.org>
Date: Thu, 19 May 2022 12:13:22 -0600
Subject: perlapi: Document do_join

---
 doop.c | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'doop.c')

diff --git a/doop.c b/doop.c
index 025d1d8086..37d7ea4d17 100644
--- a/doop.c
+++ b/doop.c
@@ -635,6 +635,28 @@ Perl_do_trans(pTHX_ SV *sv)
     }
 }
 
+/*
+=for apidoc_section $string
+=for apidoc do_join
+
+This performs a Perl L<C<join>|perlfunc/join>, placing the joined output
+into C<sv>.
+
+The elements to join are in SVs, stored in a C array of pointers to SVs, from
+C<**mark> to S<C<**sp - 1>>.  Hence C<*mark> is a reference to the first SV.
+Each SV will be coerced into a PV if not one already.
+
+C<delim> contains the string (or coerced into a string) that is to separate
+each of the joined elements.
+
+If any component is in UTF-8, the result will be as well, and all non-UTF-8
+components will be converted to UTF-8 as necessary.
+
+Magic and tainting are handled.
+
+=cut
+*/
+
 void
 Perl_do_join(pTHX_ SV *sv, SV *delim, SV **mark, SV **sp)
 {
-- 
cgit v1.2.1