summaryrefslogtreecommitdiff
path: root/pod/perlguts.pod
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2018-03-03 17:27:48 -0700
committerKarl Williamson <khw@cpan.org>2018-03-03 17:30:24 -0700
commit32128a7f27904b0ac4cc16cc0c5b0f5238cf60fd (patch)
treef6979261498b21bc33effc071428efbdda87a58d /pod/perlguts.pod
parent578a6a873a320fe64743b060dbd467f1865d205c (diff)
downloadperl-32128a7f27904b0ac4cc16cc0c5b0f5238cf60fd.tar.gz
perlguts: Clarify an example.
Diffstat (limited to 'pod/perlguts.pod')
-rw-r--r--pod/perlguts.pod11
1 files changed, 7 insertions, 4 deletions
diff --git a/pod/perlguts.pod b/pod/perlguts.pod
index 5d11da6bfc..5dce945cf1 100644
--- a/pod/perlguts.pod
+++ b/pod/perlguts.pod
@@ -2909,10 +2909,13 @@ so you can test if you need to do something special with this
character like this (the C<UTF8_IS_INVARIANT()> is a macro that tests
whether the byte is encoded as a single byte even in UTF-8):
- U8 *utf;
- U8 *utf_end; /* 1 beyond buffer pointed to by utf */
- UV uv; /* Note: a UV, not a U8, not a char */
- STRLEN len; /* length of character in bytes */
+ U8 *utf; /* Initialize this to point to the beginning of the
+ sequence to convert */
+ U8 *utf_end; /* Initialize this to 1 beyond the end of the sequence
+ pointed to by 'utf' */
+ UV uv; /* Returned code point; note: a UV, not a U8, not a
+ char */
+ STRLEN len; /* Returned length of character in bytes */
if (!UTF8_IS_INVARIANT(*utf))
/* Must treat this as UTF-8 */