From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 11 Jul 2011 22:49:26 +0000 (+0000)
Subject: Fix and improve documentation of wxT_2() macro.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/c3b8a196382ac84ca4a75d2b36cf504bc51180ae

Fix and improve documentation of wxT_2() macro.

Documentation for wxT_2() applied to wxS() instead, fix this. Also correct the
wording and add @since tags.

Closes #13321.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@68228 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/chartype.h b/interface/wx/chartype.h
index 5f380cba21..f674710020 100644
--- a/interface/wx/chartype.h
+++ b/interface/wx/chartype.h
@@ -35,10 +35,10 @@
 /**
     Compatibility macro which expands to wxT() in wxWidgets 2 only.
 
-    This macro can be used in the code which needs to compile with both
-    wxWidgets 2 and 3 versions in places where v2 API requires a Unicode string
-    (in Unicode build) and v3 API only accepts a standard narrow
-    string as in e.g. wxCmdLineEntryDesc structure objects initializers.
+    This macro can be used in code which needs to compile with both
+    wxWidgets 2 and 3 versions, in places where the wx2 API requires a Unicode string
+    (in Unicode build) but the wx3 API only accepts a standard narrow
+    string, as in e.g. wxCmdLineEntryDesc structure objects initializers.
 
     Example of use:
     @code
@@ -50,18 +50,21 @@
     };
     @endcode
 
-    Without @c wxT_2 the code above wouldn't compile with wxWidgets 2, with @c
-    wxT instead of it, it wouldn't compile with wxWidgets 3.
+    Without @c wxT_2 the code above wouldn't compile with wxWidgets 2, but using @c
+    wxT instead, it wouldn't compile with wxWidgets 3.
 
     @see wxT()
 
+    @since 2.8.12, 2.9.2
+
     @header{wx/chartype.h}
  */
+#define wxT_2(string)
 
 /**
-    wxS is macro which can be used with character and string literals (in other words,
-    @c 'x' or @c "foo") to either convert them to wide characters or wide strings
-    in @c wchar_t-based (UTF-16) builds or keep them unchanged in @c char-based
+    wxS is a macro which can be used with character and string literals (in other words,
+    @c 'x' or @c "foo") to convert them either to wide characters or wide strings
+    in @c wchar_t-based (UTF-16) builds, or to keep them unchanged in @c char-based
     (UTF-8) builds.
 
     Basically this macro produces characters or strings of type wxStringCharType.