]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/encconv.h
document standard IDs only in one place, not two; bring the list up to date
[wxWidgets.git] / interface / encconv.h
index f21e5ebea61722cf7f0b6adfd30a19f34bfb21ad..4e4c5940dec4cdc954d30668a976948fd37e1006 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        encconv.h
-// Purpose:     documentation for wxEncodingConverter class
+// Purpose:     interface of wxEncodingConverter
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -20,9 +20,8 @@
     @library{wxbase}
     @category{misc}
 
-    @seealso
-    wxFontMapper, wxMBConv, @ref overview_nonenglishoverview "Writing non-English
-    applications"
+    @see wxFontMapper, wxMBConv, @ref overview_nonenglishoverview "Writing
+    non-English applications"
 */
 class wxEncodingConverter : public wxObject
 {
@@ -76,7 +75,7 @@ public:
          wxPLATFORM_CURRENT
         wxPLATFORM_CURRENT means the platform this binary was compiled for.
         Examples:
-        
+
         Equivalence is defined in terms of convertibility:
         two encodings are equivalent if you can convert text between
         then without losing information (it may - and will - happen
@@ -101,22 +100,23 @@ public:
         it more than once in order to switch to another conversion.
         @e Method affects behaviour of Convert() in case input character
         cannot be converted because it does not exist in output encoding:
-        
+
         @b wxCONVERT_STRICT
-        
+
         follow behaviour of GNU Recode -
         just copy unconvertible  characters to output and don't change them
         (its integer value will stay the same)
-        
+
         @b wxCONVERT_SUBSTITUTE
-        
+
         try some (lossy) substitutions
         - e.g. replace unconvertible latin capitals with acute by ordinary
         capitals, replace en-dash or em-dash by '-' etc.
-        
+
         Both modes guarantee that output string will have same length
         as input string.
     */
     bool Init(wxFontEncoding input_enc, wxFontEncoding output_enc,
               int method = wxCONVERT_STRICT);
 };
+