utf8.c: Add back inadvertently deleted pod text

This was deleted by mistake in commit
4b88fb76efce8c436e63b907c9842345d4fa77c7
This commit is contained in:
Karl Williamson 2012-03-20 09:25:09 -06:00
parent 6bd1c396b2
commit 39e518fd05

3
utf8.c
View File

@ -909,6 +909,9 @@ Returns the Unicode code point of the first character in the string C<s>
which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
length, in bytes, of that character.
This function should only be used when the returned UV is considered
an index into the Unicode semantic tables (e.g. swashes).
Some, but not all, UTF-8 malformations are detected, and in fact, some
malformed input could cause reading beyond the end of the input buffer, which
is why this function is deprecated. Use L</utf8_to_uvuni_buf> instead.