From 9e2c8524411f3f35025c354c7b90c2c2bdc3703e Mon Sep 17 00:00:00 2001 From: dkf Date: Fri, 18 Jul 2003 22:15:45 +0000 Subject: Tightened up Tcl_Utf{Next,Prev} docs. [Bug 769895] --- ChangeLog | 5 +++++ doc/Utf.3 | 13 ++++++++----- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/ChangeLog b/ChangeLog index 9376de0..71a314b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2003-07-18 Donal K. Fellows + + * doc/Utf.3: Tightened up documentation of Tcl_UtfNext and + Tcl_UtfPrev to better match the behaviour. [Bug 769895] + 2003-07-18 Jeff Hobbs * generic/tclIOUtil.c: correct MT-safety issues with filesystem diff --git a/doc/Utf.3 b/doc/Utf.3 index a61a18b..0299450 100644 --- a/doc/Utf.3 +++ b/doc/Utf.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Utf.3,v 1.13.2.1 2003/07/18 16:56:24 dgp Exp $ +'\" RCS: @(#) $Id: Utf.3,v 1.13.2.2 2003/07/18 22:15:45 dkf Exp $ '\" .so man.macros .TH Utf 3 "8.1" Tcl "Tcl Library Procedures" @@ -224,11 +224,14 @@ considered part of the UTF-8 string. Given \fIsrc\fR, a pointer to some location in a UTF-8 string, \fBTcl_UtfNext\fR returns a pointer to the next UTF-8 character in the string. The caller must not ask for the next character after the last -character in the string. +character in the string if the string is not terminated by a null +character. .PP -Given \fIsrc\fR, a pointer to some location in a UTF-8 string, -\fBTcl_UtfPrev\fR returns a pointer to the previous UTF-8 character in the -string. This function will not back up to a position before \fIstart\fR, +Given \fIsrc\fR, a pointer to some location in a UTF-8 string (or to a +null byte immediately following such a string), \fBTcl_UtfPrev\fR +returns a pointer to the closest preceding byte that starts a UTF-8 +character. +This function will not back up to a position before \fIstart\fR, the start of the UTF-8 string. If \fIsrc\fR was already at \fIstart\fR, the return value will be \fIstart\fR. .PP -- cgit v0.12