summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2023-12-22 08:14:57 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2023-12-22 08:14:57 (GMT)
commiteb72dd9f57eb5decdddc6dd599fe61519e1263e5 (patch)
tree057434616965fa47925c757d0fa989740ba02731
parente413cb32068376a6874a9342c47f5e1e51619c6b (diff)
parenta8353cf92e1eb8c05a78c8904fd1280f1b765799 (diff)
downloadtcl-eb72dd9f57eb5decdddc6dd599fe61519e1263e5.zip
tcl-eb72dd9f57eb5decdddc6dd599fe61519e1263e5.tar.gz
tcl-eb72dd9f57eb5decdddc6dd599fe61519e1263e5.tar.bz2
Document "string is unicode". More documentation fixes.
-rw-r--r--doc/StringObj.34
-rw-r--r--doc/Utf.33
-rw-r--r--doc/string.n2
3 files changed, 5 insertions, 4 deletions
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index 05b5251..5a67055 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -204,8 +204,8 @@ where the caller does not need the length of the unicode string
representation.
.PP
\fBTcl_GetUniChar\fR returns the \fIindex\fR'th character in the
-value's Unicode representation. If the index is out of range or
-it references a low surrogate preceded by a high surrogate, it returns -1;
+value's Unicode representation. If the index is out of range
+it returns -1;
.PP
\fBTcl_GetRange\fR returns a newly created value comprised of the
characters between \fIfirst\fR and \fIlast\fR (inclusive) in the value's
diff --git a/doc/Utf.3 b/doc/Utf.3
index 49dfd88..6dd083f 100644
--- a/doc/Utf.3
+++ b/doc/Utf.3
@@ -305,8 +305,7 @@ byte \fIsrc[0]\fR nor the byte \fIstart[-1]\fR nor the byte
Pascal Ord() function. It returns the Unicode character represented at the
specified character (not byte) \fIindex\fR in the UTF-8 string
\fIsrc\fR. The source string must contain at least \fIindex\fR
-characters. If \fIindex\fR is negative or \fIindex\fR points
-to the second half of a surrogate pair, it returns -1.
+characters. If \fIindex\fR is negative it returns -1.
.PP
\fBTcl_UtfAtIndex\fR returns a pointer to the specified character (not
byte) \fIindex\fR in the UTF-8 string \fIsrc\fR. The source string must
diff --git a/doc/string.n b/doc/string.n
index 5c493f5..76f98c6 100644
--- a/doc/string.n
+++ b/doc/string.n
@@ -174,6 +174,8 @@ zero width no-break space (U+feff) (=BOM).
.IP \fBtrue\fR 12
Any of the forms allowed to \fBTcl_GetBoolean\fR where the value is
true.
+.IP \fBunicode\fR 12
+Any Unicode character, except surrogates and noncharacters
.IP \fBupper\fR 12
Any upper case alphabet character in the Unicode character set.
.IP \fBwideinteger\fR 12