regenerated headers to remove @seealso in favour of @see; fixed links to global functions/macros; converted \since latex macros into @wxsince commands; changed headers purpose from 'documentation for' to 'interface of'

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52425 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-10 15:24:38 +00:00
parent 3a65144e7c
commit e54c96f187
269 changed files with 2027 additions and 1553 deletions

View File

@@ -1,6 +1,6 @@
/////////////////////////////////////////////////////////////////////////////
// Name: strconv.h
// Purpose: documentation for wxMBConvUTF7 class
// Purpose: interface of wxMBConvUTF7
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@@ -18,8 +18,7 @@
@library{wxbase}
@category{FIXME}
@seealso
wxMBConvUTF8, @ref overview_mbconvclasses "wxMBConv classes overview"
@see wxMBConvUTF8, @ref overview_mbconvclasses "wxMBConv classes overview"
*/
class wxMBConvUTF7 : public wxMBConv
{
@@ -38,6 +37,7 @@ public:
};
/**
@class wxMBConvUTF8
@wxheader{strconv.h}
@@ -48,8 +48,7 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
wxMBConvUTF7, @ref overview_mbconvclasses "wxMBConv classes overview"
@see wxMBConvUTF7, @ref overview_mbconvclasses "wxMBConv classes overview"
*/
class wxMBConvUTF8 : public wxMBConv
{
@@ -68,12 +67,13 @@ public:
};
/**
@class wxMBConvUTF16
@wxheader{strconv.h}
This class is used to convert between multibyte encodings and UTF-16 Unicode
encoding (also known as UCS-2). Unlike UTF-8 encoding,
encoding (also known as UCS-2). Unlike UTF-8() encoding,
UTF-16 uses words and not bytes and hence depends on the byte ordering:
big or little endian. Hence this class is provided in two versions:
wxMBConvUTF16LE and wxMBConvUTF16BE and wxMBConvUTF16 itself is just a typedef
@@ -83,8 +83,7 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
wxMBConvUTF8, wxMBConvUTF32, @ref overview_mbconvclasses "wxMBConv classes
@see wxMBConvUTF8, wxMBConvUTF32, @ref overview_mbconvclasses "wxMBConv classes
overview"
*/
class wxMBConvUTF16 : public wxMBConv
@@ -104,6 +103,7 @@ public:
};
/**
@class wxCSConv
@wxheader{strconv.h}
@@ -115,9 +115,8 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
wxMBConv, wxEncodingConverter, @ref overview_mbconvclasses "wxMBConv classes
overview"
@see wxMBConv, wxEncodingConverter, @ref overview_mbconvclasses "wxMBConv
classes overview"
*/
class wxCSConv : public wxMBConv
{
@@ -142,7 +141,8 @@ public:
available to use. Returns @false if ISO 8859-1 will be used instead.
Note this does not mean that a given string will be correctly converted.
A malformed string may still make conversion functions return @c wxCONV_FAILED.
This function is new since wxWidgets version 2.8.2
@wxsince{2.8.2}
*/
bool IsOk() const;
@@ -160,6 +160,7 @@ public:
};
/**
@class wxMBConvFile
@wxheader{strconv.h}
@@ -192,8 +193,7 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
@ref overview_mbconvclasses "wxMBConv classes overview"
@see @ref overview_mbconvclasses "wxMBConv classes overview"
*/
class wxMBConvFile : public wxMBConv
{
@@ -212,12 +212,13 @@ public:
};
/**
@class wxMBConvUTF32
@wxheader{strconv.h}
This class is used to convert between multibyte encodings and UTF-32 Unicode
encoding (also known as UCS-4). Unlike UTF-8 encoding,
encoding (also known as UCS-4). Unlike UTF-8() encoding,
UTF-32 uses (double) words and not bytes and hence depends on the byte ordering:
big or little endian. Hence this class is provided in two versions:
wxMBConvUTF32LE and wxMBConvUTF32BE and wxMBConvUTF32 itself is just a typedef
@@ -227,8 +228,7 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
wxMBConvUTF8, wxMBConvUTF16, @ref overview_mbconvclasses "wxMBConv classes
@see wxMBConvUTF8, wxMBConvUTF16, @ref overview_mbconvclasses "wxMBConv classes
overview"
*/
class wxMBConvUTF32 : public wxMBConv
@@ -248,6 +248,7 @@ public:
};
/**
@class wxMBConv
@wxheader{strconv.h}
@@ -266,9 +267,8 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
wxCSConv, wxEncodingConverter, @ref overview_mbconvclasses "wxMBConv classes
overview"
@see wxCSConv, wxEncodingConverter, @ref overview_mbconvclasses "wxMBConv
classes overview"
*/
class wxMBConv
{
@@ -455,3 +455,4 @@ public:
const const wxWCharBuffer cWX2WC(const wxChar* psz) const;
//@}
};