Corrected c_str() docs

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

diff --git a/interface/wx/string.h b/interface/wx/string.h
index 5daa5d3493237747dfbf63f8fcb7ca046e470acd..f8d8d715b378d11d5c47ee4dcfd1ece0d12ef67e 100644 (file)
--- a/interface/wx/string.h
+++ b/interface/wx/string.h
@@ -1004,12 +1004,16 @@ public:
     void UpperCase();
 
     /**
     void UpperCase();
 
     /**

-        Returns a pointer to the string data (@c const char* when using UTF-8
-        internally, @c const wchar_t* when using UCS-2 internally).
-
+        Returns a lightweight intermediate class which is in turn implicitly
+        convertible to both @c const @c char* and to @c const @c wchar_t*.
+        
+        Please see the @ref overview_unicode "Unicode overview" for more
+        information about it.
+        

         Note that the returned value is not convertible to @c char* or
         @c wchar_t*, use char_str() or wchar_str() if you need to pass
         string value to a function expecting non-const pointer.
         Note that the returned value is not convertible to @c char* or
         @c wchar_t*, use char_str() or wchar_str() if you need to pass
         string value to a function expecting non-const pointer.

+        

     */
     const wxCStrData c_str() const;
 
     */
     const wxCStrData c_str() const;