document recently added enums

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

diff --git a/interface/wx/chartype.h b/interface/wx/chartype.h
index 474cfd044dbe2692227ac67fe2c043c87673ae64..d9c3e9c89520386075c6e938f9c8a706b90aa0e8 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 */
 //@{
 
 /**
@@ -23,6 +23,9 @@
 #endif
 @endcode
 
+    Note that since wxWidgets 2.9.0 you shouldn't use wxT() anymore in your
+    program sources if you want to support Unicode.
+
     @see @ref overview_unicode, wxS()
 
     @header{wx/chartype.h}
@@ -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.
@@ -88,9 +93,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;