This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
utf8.c: Clarify pod for three functions
authorKarl Williamson <khw@cpan.org>
Tue, 6 Jun 2017 07:54:46 +0000 (01:54 -0600)
committerKarl Williamson <khw@cpan.org>
Thu, 8 Jun 2017 17:18:50 +0000 (11:18 -0600)
utf8_to_bytes(), bytes_from_utf8(), bytes_to_utf8()

utf8.c

diff --git a/utf8.c b/utf8.c
index dd8cec8..c84fa98 100644 (file)
--- a/utf8.c
+++ b/utf8.c
@@ -1907,10 +1907,14 @@ Perl_bytes_cmp_utf8(pTHX_ const U8 *b, STRLEN blen, const U8 *u, STRLEN ulen)
 /*
 =for apidoc utf8_to_bytes
 
-Converts a string C<s> of length C<*lenp> from UTF-8 into native byte encoding.
+Converts a string C<"s"> of length C<*lenp> from UTF-8 into native byte encoding.
 Unlike L</bytes_to_utf8>, this over-writes the original string, and
 updates C<*lenp> to contain the new length.
-Returns zero on failure,  setting C<*lenp> to -1.
+Returns zero on failure (leaving C<"s"> unchanged) setting C<*lenp> to -1.
+
+Upon successful return, the number of variants in the string can be computed by
+saving the value of C<*lenp> before the call, and subtracting the after-call
+value of C<*lenp> from it.
 
 If you need a copy of the string, see L</bytes_from_utf8>.
 
@@ -1985,6 +1989,10 @@ Otherwise, C<*is_utf8> is set to 0, and the return value is a pointer to a
 newly created string containing a downgraded copy of C<s>, and whose length is
 returned in C<*lenp>, updated.
 
+Upon successful return, the number of variants in the string can be computed by
+saving the value of C<*lenp> before the call, and subtracting the after-call
+value of C<*lenp> from it.
+
 =cut
 */
 
@@ -2048,6 +2056,10 @@ UTF-8.
 Returns a pointer to the newly-created string, and sets C<*lenp> to
 reflect the new length in bytes.
 
+Upon successful return, the number of variants in the string can be computed by
+saving the value of C<*lenp> before the call, and subtracting it from the
+after-call value of C<*lenp>.
+
 A C<NUL> character will be written after the end of the string.
 
 If you want to convert to UTF-8 from encodings other than