correct wxSortedArrayString(wxArrayString) ctor documentation (closes #10944)

[wxWidgets.git] / interface / wx / chartype.h

diff --git a/interface/wx/chartype.h b/interface/wx/chartype.h
index 474cfd044dbe2692227ac67fe2c043c87673ae64..59c51e82324fec4b0080e96afe98d4bcf031ce29 100644 (file)
--- a/interface/wx/chartype.h
+++ b/interface/wx/chartype.h
@@ -6,7 +6,7 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-/** @ingroup group_funcmacro_string */
+/** @addtogroup group_funcmacro_string */
 //@{
 
 /**
@@ -15,13 +15,16 @@
     builds of wxWidgets. This macro simply returns the value passed to it
     without changes in ASCII build. In fact, its definition is:
 
-@code
-#ifdef UNICODE
-#   define wxT(x)  L##x
-#else // !Unicode
-#   define wxT(x)  x
-#endif
-@endcode
+    @code
+    #ifdef UNICODE
+    #   define wxT(x)  L##x
+    #else // !Unicode
+    #   define wxT(x)  x
+    #endif
+    @endcode
+
+    Note that since wxWidgets 2.9.0 you shouldn't use wxT() anymore in your
+    program sources (it was previously required if you wanted to support Unicode).
 
     @see @ref overview_unicode, wxS()
 
@@ -35,6 +38,8 @@
     in @c wchar_t-based (UTF-16) builds or keep them unchanged in @c char-based
     (UTF-8) builds.
 
+    Basically this macro produces characters or strings of type wxStringCharType.
+
     The use of this macro is optional as the translation will always be done at
     run-time even if there is a mismatch between the kind of the literal used
     and the string or character type used in the current build.
@@ -55,6 +60,8 @@
 
     Don't confuse this macro with _()!
 
+    Note that since wxWidgets 2.9.0 the use of _T() is discouraged just like for wxT().
+
     @header{wx/chartype.h}
 */
 #define _T(string)
@@ -88,9 +95,11 @@ typedef wxUSE_UNICODE_dependent wxUChar;
 
     The @c wxUSE_UNICODE_WCHAR symbol is defined to @c 1 when building on
     Windows while it's defined to @c 0 when building on Unix, Linux or OS X.
+    (Note that @c wxUSE_UNICODE_UTF8 symbol is defined as the opposite of
+    @c wxUSE_UNICODE_WCHAR.)
 
-    Note that wxStringCharType is the type used by wxString for internal storage
-    of the characters.
+    Note that wxStringCharType (as the name says) is the type used by wxString
+    for internal storage of the characters.
 */
 typedef wxUSE_UNICODE_WCHAR_dependent wxStringCharType;