Tightened up Tcl_Utf{Next,Prev} docs. [Bug 769895]

2 files changed, 13 insertions, 5 deletions

diff --git a/ChangeLog b/ChangeLog
index c9aeb74..7fe4a77 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2003-07-18  Donal K. Fellows  <fellowsd@cs.man.ac.uk>
+
+	* doc/Utf.3: Tightened up documentation of Tcl_UtfNext and
+	Tcl_UtfPrev to better match the behaviour. [Bug 769895]
+
 2003-07-18  Jeff Hobbs  <jeffh@ActiveState.com>
 
 	* library/http/pkgIndex.tcl: upped to http v2.4.4
diff --git a/doc/Utf.3 b/doc/Utf.3
index 9b1b44e..0656dc1 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.14 2003/07/18 16:56:41 dgp Exp $
+'\" RCS: @(#) $Id: Utf.3,v 1.15 2003/07/18 22:17:35 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