minor formatting

[wxWidgets.git] / interface / chartype.h

diff --git a/interface/chartype.h b/interface/chartype.h
index 702e85f4e267c6c3b779547c45ae459166f0e696..af71092399929d06fe28edaa0b3130e9b32a4165 100644 (file)
--- a/interface/chartype.h
+++ b/interface/chartype.h
@@ -1,47 +1,59 @@
 /////////////////////////////////////////////////////////////////////////////
-    // Name:        chartype.h
-    // Purpose:     documentation for global functions
-    // Author:      wxWidgets team
-    // RCS-ID:      $Id$
-    // Licence:     wxWindows license
-    /////////////////////////////////////////////////////////////////////////////
-    
-    //@{
+// Name:        chartype.h
+// Purpose:     interface of global functions
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/** @ingroup group_funcmacro_string */
+//@{
+
 /**
-    wxT() is a macro which can be used with character and string literals (in other
-    words, @c 'x' or @c "foo") to automatically convert them to Unicode in
-    Unicode build configuration. Please see the
-    @ref overview_unicode "Unicode overview" for more information.
-    
-    This macro is 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
-*/
-wxChar wxT(char ch);
-    const wxChar * wxT(const char * s);
-//@}
+    This macro can be used with character and string literals (in other words,
+    @c 'x' or @c "foo") to automatically convert them to Unicode in Unicode
+    builds of wxWidgets. This macro is 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
+
+    @see @ref overview_unicode
+
+    @header{wx/chartype.h}
+*/
+#define wxT(string)
 
-    //@{
 /**
     wxS is macro which can be used with character and string literals to either
     convert them to wide characters or strings in @c wchar_t-based Unicode
     builds or keep them unchanged in UTF-8 builds. 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 wxStringCharType used in the
-    current build, but using it can be beneficial in performance-sensitive code to
-    do the conversion at compile-time instead.
-    
-    @sa wxT
+    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 string or character
+    type used in the current build, but using it can be beneficial in
+    performance-sensitive code to do the conversion at compile-time instead.
+
+    @see wxT()
+
+    @header{wx/chartype.h}
 */
-wxStringCharType wxS(char ch);
-    const wxStringCharType * wxS(const char * s);
-//@}
+#define wxS(string)
+
+/**
+    This macro is exactly the same as wxT() and is defined in wxWidgets simply
+    because it may be more intuitive for Windows programmers as the standard
+    Win32 headers also define it (as well as yet another name for the same
+    macro which is _TEXT()).
 
+    Don't confuse this macro with _()!
+
+    @header{wx/chartype.h}
+*/
+#define _T(string)
+
+//@}