summaryrefslogtreecommitdiff
path: root/utf8.c
diff options
context:
space:
mode:
authorKarl Williamson <public@khwilliamson.com>2010-12-19 12:24:07 -0700
committerKarl Williamson <public@khwilliamson.com>2010-12-19 20:22:04 -0700
commitff97e5cf7f9d89732c45b74ff5abc53519433776 (patch)
treee184d3f4fbf57d722eaa006e480f90cd04baa1de /utf8.c
parent6426c51b011a78db74b51fc0517bb3f21cef8dc1 (diff)
downloadperl-ff97e5cf7f9d89732c45b74ff5abc53519433776.tar.gz
utf8.c, .h: Clarify pod and comment
Diffstat (limited to 'utf8.c')
-rw-r--r--utf8.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/utf8.c b/utf8.c
index e615d7b622..732b06e5cc 100644
--- a/utf8.c
+++ b/utf8.c
@@ -980,9 +980,10 @@ Perl_bytes_from_utf8(pTHX_ const U8 *s, STRLEN *len, bool *is_utf8)
/*
=for apidoc bytes_to_utf8
-Converts a string C<s> of length C<len> from the native encoding into UTF-8.
+Converts a string C<s> of length C<len> bytes from the native encoding into
+UTF-8.
Returns a pointer to the newly-created string, and sets C<len> to
-reflect the new length.
+reflect the new length in bytes.
A NUL character will be written after the end of the string.