]> git.saurik.com Git - wxWidgets.git/commitdiff
fix some wording and a typo
authorFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Mon, 19 Jan 2009 00:21:31 +0000 (00:21 +0000)
committerFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Mon, 19 Jan 2009 00:21:31 +0000 (00:21 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58217 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/doxygen/overviews/string.h

index 3829548e3c0e5587acfc056a929a7f21b7f2d1a9..f74c6e3a2e07c712565d29dafb3bea3d5eb34835 100644 (file)
@@ -56,7 +56,7 @@ see the @ref overview_unicode_encodings paragraph.
 For simplicity of implementation, wxString when <tt>wxUSE_UNICODE_WCHAR==1</tt>
 (e.g. on Windows) uses <em>per code unit indexing</em> instead of
 <em>per code point indexing</em> and doesn't know anything about surrogate pairs;
-in other words it always considers code points to be composed by 1 code point,
+in other words it always considers code points to be composed by 1 code unit,
 while this is really true only for characters in the @e BMP (Basic Multilingual Plane).
 Thus when iterating over a UTF-16 string stored in a wxString under Windows, the user
 code has to take care of <em>surrogate pairs</em> himself.
@@ -66,7 +66,9 @@ such as for drawing strings on screen.)
 @remarks
 Note that while the behaviour of wxString when <tt>wxUSE_UNICODE_WCHAR==1</tt>
 resembles UCS-2 encoding, it's not completely correct to refer to wxString as
-UCS-2 encoded since you can encode characters outside the @e BMP in a wxString.
+UCS-2 encoded since you can encode code points outside the @e BMP in a wxString
+as two code units (i.e. as a surrogate pair; as already mentioned however wxString
+will "see" them as two different code points)
 
 When instead <tt>wxUSE_UNICODE_UTF8==1</tt> (e.g. on Linux and Mac OS X)
 wxString handles UTF8 multi-bytes sequences just fine also for characters outside