summaryrefslogtreecommitdiff
path: root/utf8.c
diff options
context:
space:
mode:
authorKarl Williamson <khw@khw-desktop.(none)>2010-05-25 11:17:22 -0600
committerYves Orton <demerphq@gmail.com>2010-06-05 23:23:58 +0200
commit970ea3cb860f5a38a7f7582cc02c1b88c0bf4b0f (patch)
treef72c1ee193436bd5814be01a49e5cc6f275b7d10 /utf8.c
parent5ac3629776cb773f868455ce02860eafa022c003 (diff)
downloadperl-970ea3cb860f5a38a7f7582cc02c1b88c0bf4b0f.tar.gz
Clarify some documentation
Diffstat (limited to 'utf8.c')
-rw-r--r--utf8.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/utf8.c b/utf8.c
index eeea1582b8..6c522d033a 100644
--- a/utf8.c
+++ b/utf8.c
@@ -33,7 +33,7 @@
#include "perl.h"
#ifndef EBCDIC
-/* Separate prototypes needed because in ASCII systems these
+/* Separate prototypes needed because in ASCII systems these are
* usually macros but they still are compiled as code, too. */
PERL_CALLCONV UV Perl_utf8n_to_uvchr(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags);
PERL_CALLCONV U8* Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv);
@@ -57,8 +57,10 @@ within non-zero characters.
/*
=for apidoc is_ascii_string
-Returns true if first C<len> bytes of the given string are ASCII (i.e. none
-of them even raise the question of UTF-8-ness).
+Returns true if the first C<len> bytes of the given string are the same whether
+or not the string is encoded in UTF-8 (or UTF-EBCDIC on EBCDIC machines). That
+is, if they are invariant. On ASCII-ish machines, only ASCII characters
+fit this definition, hence the function's name.
See also is_utf8_string(), is_utf8_string_loclen(), and is_utf8_string_loc().