Mention wxConvLocal in wxString

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

diff --git a/interface/strconv.h b/interface/strconv.h
index 834401a506a53614733701b26d81f1739ef95866..20cc3613980accc4fead7cbea8ec68ff926d6e70 100644 (file)
--- a/interface/strconv.h
+++ b/interface/strconv.h
@@ -18,7 +18,7 @@
     @library{wxbase}
     @category{FIXME}
 
     @library{wxbase}
     @category{FIXME}
 

-    @see wxMBConvUTF8, @ref overview_mbconvclasses "wxMBConv classes overview"
+    @see wxMBConvUTF8, @ref overview_mbconv "wxMBConv classes overview"

 */
 class wxMBConvUTF7 : public wxMBConv
 {
 */
 class wxMBConvUTF7 : public wxMBConv
 {


@@ -48,7 +48,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
     @library{wxbase}
     @category{FIXME}
 

-    @see wxMBConvUTF7, @ref overview_mbconvclasses "wxMBConv classes overview"
+    @see wxMBConvUTF7, @ref overview_mbconv "wxMBConv classes overview"

 */
 class wxMBConvUTF8 : public wxMBConv
 {
 */
 class wxMBConvUTF8 : public wxMBConv
 {


@@ -83,7 +83,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
     @library{wxbase}
     @category{FIXME}
 

-    @see wxMBConvUTF8, wxMBConvUTF32, @ref overview_mbconvclasses "wxMBConv classes
+    @see wxMBConvUTF8, wxMBConvUTF32, @ref overview_mbconv "wxMBConv classes

     overview"
 */
 class wxMBConvUTF16 : public wxMBConv
     overview"
 */
 class wxMBConvUTF16 : public wxMBConv


@@ -115,21 +115,25 @@ public:
     @library{wxbase}
     @category{FIXME}
 
     @library{wxbase}
     @category{FIXME}
 

-    @see wxMBConv, wxEncodingConverter, @ref overview_mbconvclasses "wxMBConv
+    @see wxMBConv, wxEncodingConverter, @ref overview_mbconv "wxMBConv

     classes overview"
 */
 class wxCSConv : public wxMBConv
 {
 public:
     classes overview"
 */
 class wxCSConv : public wxMBConv
 {
 public:

-    //@{

     /**
     /**

-        Constructor. You may specify either the name of the character set you want to
-        convert from/to or an encoding constant. If the character set name (or the
-        encoding) is not recognized, ISO 8859-1 is used as fall back.
+        Constructor. You can specify the name of the character set you want to
+        convert from/to. If the character set name is not recognized, ISO 8859-1
+        is used as fall back.

     */
     wxCSConv(const wxChar* charset);
     */
     wxCSConv(const wxChar* charset);

+    
+    /**
+        Constructor. You can specify an encoding constant for the 
+        character set you want to convert from/to or. If the encoding
+        is not recognized, ISO 8859-1 is used as fall back.
+    */

     wxCSConv(wxFontEncoding encoding);
     wxCSConv(wxFontEncoding encoding);

-    //@}

 
     /**
         Destructor frees any resources needed to perform the conversion.
 
     /**
         Destructor frees any resources needed to perform the conversion.


@@ -193,7 +197,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
     @library{wxbase}
     @category{FIXME}
 

-    @see @ref overview_mbconvclasses "wxMBConv classes overview"
+    @see @ref overview_mbconv "wxMBConv classes overview"

 */
 class wxMBConvFile : public wxMBConv
 {
 */
 class wxMBConvFile : public wxMBConv
 {


@@ -228,7 +232,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
     @library{wxbase}
     @category{FIXME}
 

-    @see wxMBConvUTF8, wxMBConvUTF16, @ref overview_mbconvclasses "wxMBConv classes
+    @see wxMBConvUTF8, wxMBConvUTF16, @ref overview_mbconv "wxMBConv classes

     overview"
 */
 class wxMBConvUTF32 : public wxMBConv
     overview"
 */
 class wxMBConvUTF32 : public wxMBConv


@@ -267,7 +271,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
     @library{wxbase}
     @category{FIXME}
 

-    @see wxCSConv, wxEncodingConverter, @ref overview_mbconvclasses "wxMBConv
+    @see wxCSConv, wxEncodingConverter, @ref overview_mbconv "wxMBConv

     classes overview"
 */
 class wxMBConv
     classes overview"
 */
 class wxMBConv

diff --git a/interface/string.h b/interface/string.h
index 8c7cc5a34dbb50c7857b236e16f0f4b101f964df..a04d2146641d0ae5d17267b928ebd92a7c8d7bf8 100644 (file)
--- a/interface/string.h
+++ b/interface/string.h
@@ -106,6 +106,11 @@ public:
     @ref overview_unicode "Unicode overview" for more information
     about it.
 
     @ref overview_unicode "Unicode overview" for more information
     about it.
 

+    wxString uses the current locale encoding to convert any C string
+    literal to Unicode. The same is done for converting to and from
+    @c std::string and for the return value of c_str(). For this
+    conversion, the @a wxConvLocal class instance is used. See wxCSConv.
+

     wxString implements most of the methods of the @c std::string class.
     These standard functions are only listed here, but there are not 
     fully documented in this manual. Please see the STL documentation.
     wxString implements most of the methods of the @c std::string class.
     These standard functions are only listed here, but there are not 
     fully documented in this manual. Please see the STL documentation.