create a separate category for the conversion classes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53883 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2008-05-31 22:35:24 +00:00
parent 871ff36618
commit 79b40dcf07
3 changed files with 44 additions and 11 deletions

View File

@ -0,0 +1,17 @@
/////////////////////////////////////////////////////////////////////////////
// Name: class_conv.h
// Purpose: Conversion classes group docs
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_class_conv Text Conversion
@ingroup group_class
These are the classes used for conversions between different text encodings.
*/

View File

@ -44,6 +44,7 @@ This page contains a summarized listing of classes, please see the
@li @ref page_class_cat_logging
@li @ref page_class_cat_threading
@li @ref page_class_cat_data
@li @ref page_class_cat_conv
@li @ref page_class_cat_containers
@li @ref page_class_cat_smartpointers
@li @ref page_class_cat_file
@ -657,6 +658,23 @@ These are the data structure classes supported by wxWidgets.
@section page_class_cat_conv Text Conversion
These classes define objects for performing conversions between different
multibyte and Unicode encodings and wide character strings.
@li wxMBConv: Base class for all convertors, defines the API implemented by all
the other convertor classes.
@li wxMBConvUTF7: Convertor for UTF-7
@li wxMBConvUTF8: Convertor for UTF-8
@li wxMBConvUTF16: Convertor for UTF-16
@li wxMBConvUTF32: Convertor for UTF-32
@li wxCSConv: Convertor for any system-supported encoding which can be
specified by name.
Related Overviews: @ref overview_mbconv
@section page_class_cat_containers Containers
These are classes, templates and class macros are used by wxWidgets. Most of

View File

@ -13,10 +13,8 @@
This class converts between the UTF-7 encoding and Unicode.
It has one predefined instance, @b wxConvUTF7.
@b WARNING: this class is not implemented yet.
@library{wxbase}
@category{FIXME}
@category{conv}
@see wxMBConvUTF8, @ref overview_mbconv "wxMBConv classes overview"
*/
@ -46,7 +44,7 @@ public:
It has one predefined instance, @b wxConvUTF8.
@library{wxbase}
@category{FIXME}
@category{conv}
@see wxMBConvUTF7, @ref overview_mbconv "wxMBConv classes overview"
*/
@ -81,7 +79,7 @@ public:
under Mac).
@library{wxbase}
@category{FIXME}
@category{conv}
@see wxMBConvUTF8, wxMBConvUTF32, @ref overview_mbconv "wxMBConv classes overview"
*/
@ -112,7 +110,7 @@ public:
default user character set.
@library{wxbase}
@category{FIXME}
@category{conv}
@see wxMBConv, wxEncodingConverter, @ref overview_mbconv "wxMBConv classes overview"
*/
@ -125,9 +123,9 @@ public:
is used as fall back.
*/
wxCSConv(const wxChar* charset);
/**
Constructor. You can specify an encoding constant for the
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.
*/
@ -193,7 +191,7 @@ public:
(although it would be better to use wxFopen(name, wxT("r")) in this case.)
@library{wxbase}
@category{FIXME}
@category{conv}
@see @ref overview_mbconv "wxMBConv classes overview"
*/
@ -228,7 +226,7 @@ public:
under Mac).
@library{wxbase}
@category{FIXME}
@category{conv}
@see wxMBConvUTF8, wxMBConvUTF16, @ref overview_mbconv "wxMBConv classes overview"
*/
@ -266,7 +264,7 @@ public:
under Windows) or 4 (Unix).
@library{wxbase}
@category{FIXME}
@category{conv}
@see wxCSConv, wxEncodingConverter, @ref overview_mbconv "wxMBConv classes overview"
*/