This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Document UNICODE_REPLACEMENT
authorKarl Williamson <khw@cpan.org>
Mon, 5 Aug 2019 00:01:11 +0000 (18:01 -0600)
committerKarl Williamson <khw@cpan.org>
Tue, 3 Sep 2019 03:52:10 +0000 (21:52 -0600)
utf8.h

diff --git a/utf8.h b/utf8.h
index 8ab27f5..4c699d8 100644 (file)
--- a/utf8.h
+++ b/utf8.h
@@ -275,6 +275,7 @@ platforms.  FF signals to use 13 bytes for the encoded character.  This breaks
 the paradigm that the number of leading bits gives how many total bytes there
 are in the character.
 
+=cut
 */
 
 /* Is the representation of the Unicode code point 'cp' the same regardless of
@@ -866,6 +867,10 @@ of the Unicode non-character code points; otherwise it evaluates to 0.  If
 non-zero, the value gives how many bytes starting at C<s> comprise the code
 point's representation.
 
+=for apidoc AmnU|UV|UNICODE_REPLACEMENT
+
+Evaluates to 0xFFFD, the code point of the Unicode REPLACEMENT CHARACTER
+
 =cut
  */
 #define UTF8_IS_NONCHAR(s, e)                                                  \