From 9a6fda2288944cf3a8fc9ba1d33746b903daff60 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Sat, 7 Feb 2009 15:09:48 +0000 Subject: [PATCH] do not use preprocessor macros in interface headers; doxygen doesn't know about preprocessor symbols used in the real headers git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58711 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/font.h | 123 ++++++++++++++++++++---------------------- interface/wx/intl.h | 32 +++++++---- interface/wx/sckipc.h | 8 +-- 3 files changed, 79 insertions(+), 84 deletions(-) diff --git a/interface/wx/font.h b/interface/wx/font.h index 193dbaae1f..d00738a0dd 100644 --- a/interface/wx/font.h +++ b/interface/wx/font.h @@ -97,63 +97,63 @@ enum wxFontEncoding wxFONTENCODING_DEFAULT, // current default encoding // ISO8859 standard defines a number of single-byte charsets - wxFONTENCODING_ISO8859_1, // West European (Latin1) - wxFONTENCODING_ISO8859_2, // Central and East European (Latin2) - wxFONTENCODING_ISO8859_3, // Esperanto (Latin3) - wxFONTENCODING_ISO8859_4, // Baltic (old) (Latin4) - wxFONTENCODING_ISO8859_5, // Cyrillic - wxFONTENCODING_ISO8859_6, // Arabic - wxFONTENCODING_ISO8859_7, // Greek - wxFONTENCODING_ISO8859_8, // Hebrew - wxFONTENCODING_ISO8859_9, // Turkish (Latin5) - wxFONTENCODING_ISO8859_10, // Variation of Latin4 (Latin6) - wxFONTENCODING_ISO8859_11, // Thai - wxFONTENCODING_ISO8859_12, // doesn't exist currently, but put it - // here anyhow to make all ISO8859 - // consecutive numbers - wxFONTENCODING_ISO8859_13, // Baltic (Latin7) - wxFONTENCODING_ISO8859_14, // Latin8 - wxFONTENCODING_ISO8859_15, // Latin9 (a.k.a. Latin0, includes euro) + wxFONTENCODING_ISO8859_1, //!< West European (Latin1) + wxFONTENCODING_ISO8859_2, //!< Central and East European (Latin2) + wxFONTENCODING_ISO8859_3, //!< Esperanto (Latin3) + wxFONTENCODING_ISO8859_4, //!< Baltic (old) (Latin4) + wxFONTENCODING_ISO8859_5, //!< Cyrillic + wxFONTENCODING_ISO8859_6, //!< Arabic + wxFONTENCODING_ISO8859_7, //!< Greek + wxFONTENCODING_ISO8859_8, //!< Hebrew + wxFONTENCODING_ISO8859_9, //!< Turkish (Latin5) + wxFONTENCODING_ISO8859_10, //!< Variation of Latin4 (Latin6) + wxFONTENCODING_ISO8859_11, //!< Thai + wxFONTENCODING_ISO8859_12, //!< doesn't exist currently, but put it + //!< here anyhow to make all ISO8859 + //!< consecutive numbers + wxFONTENCODING_ISO8859_13, //!< Baltic (Latin7) + wxFONTENCODING_ISO8859_14, //!< Latin8 + wxFONTENCODING_ISO8859_15, //!< Latin9 (a.k.a. Latin0, includes euro) wxFONTENCODING_ISO8859_MAX, // Cyrillic charset soup (see http://czyborra.com/charsets/cyrillic.html) - wxFONTENCODING_KOI8, // KOI8 Russian - wxFONTENCODING_KOI8_U, // KOI8 Ukrainian - wxFONTENCODING_ALTERNATIVE, // same as MS-DOS CP866 - wxFONTENCODING_BULGARIAN, // used under Linux in Bulgaria + wxFONTENCODING_KOI8, //!< KOI8 Russian + wxFONTENCODING_KOI8_U, //!< KOI8 Ukrainian + wxFONTENCODING_ALTERNATIVE, //!< same as MS-DOS CP866 + wxFONTENCODING_BULGARIAN, //!< used under Linux in Bulgaria // what would we do without Microsoft? They have their own encodings // for DOS - wxFONTENCODING_CP437, // original MS-DOS codepage - wxFONTENCODING_CP850, // CP437 merged with Latin1 - wxFONTENCODING_CP852, // CP437 merged with Latin2 - wxFONTENCODING_CP855, // another cyrillic encoding - wxFONTENCODING_CP866, // and another one + wxFONTENCODING_CP437, //!< original MS-DOS codepage + wxFONTENCODING_CP850, //!< CP437 merged with Latin1 + wxFONTENCODING_CP852, //!< CP437 merged with Latin2 + wxFONTENCODING_CP855, //!< another cyrillic encoding + wxFONTENCODING_CP866, //!< and another one // and for Windows - wxFONTENCODING_CP874, // WinThai - wxFONTENCODING_CP932, // Japanese (shift-JIS) - wxFONTENCODING_CP936, // Chinese simplified (GB) - wxFONTENCODING_CP949, // Korean (Hangul charset) - wxFONTENCODING_CP950, // Chinese (traditional - Big5) - wxFONTENCODING_CP1250, // WinLatin2 - wxFONTENCODING_CP1251, // WinCyrillic - wxFONTENCODING_CP1252, // WinLatin1 - wxFONTENCODING_CP1253, // WinGreek (8859-7) - wxFONTENCODING_CP1254, // WinTurkish - wxFONTENCODING_CP1255, // WinHebrew - wxFONTENCODING_CP1256, // WinArabic - wxFONTENCODING_CP1257, // WinBaltic (same as Latin 7) + wxFONTENCODING_CP874, //!< WinThai + wxFONTENCODING_CP932, //!< Japanese (shift-JIS) + wxFONTENCODING_CP936, //!< Chinese simplified (GB) + wxFONTENCODING_CP949, //!< Korean (Hangul charset) + wxFONTENCODING_CP950, //!< Chinese (traditional - Big5) + wxFONTENCODING_CP1250, //!< WinLatin2 + wxFONTENCODING_CP1251, //!< WinCyrillic + wxFONTENCODING_CP1252, //!< WinLatin1 + wxFONTENCODING_CP1253, //!< WinGreek (8859-7) + wxFONTENCODING_CP1254, //!< WinTurkish + wxFONTENCODING_CP1255, //!< WinHebrew + wxFONTENCODING_CP1256, //!< WinArabic + wxFONTENCODING_CP1257, //!< WinBaltic (same as Latin 7) wxFONTENCODING_CP12_MAX, - wxFONTENCODING_UTF7, // UTF-7 Unicode encoding - wxFONTENCODING_UTF8, // UTF-8 Unicode encoding - wxFONTENCODING_EUC_JP, // Extended Unix Codepage for Japanese - wxFONTENCODING_UTF16BE, // UTF-16 Big Endian Unicode encoding - wxFONTENCODING_UTF16LE, // UTF-16 Little Endian Unicode encoding - wxFONTENCODING_UTF32BE, // UTF-32 Big Endian Unicode encoding + wxFONTENCODING_UTF7, //!< UTF-7 Unicode encoding + wxFONTENCODING_UTF8, //!< UTF-8 Unicode encoding + wxFONTENCODING_EUC_JP, //!< Extended Unix Codepage for Japanese + wxFONTENCODING_UTF16BE, //!< UTF-16 Big Endian Unicode encoding + wxFONTENCODING_UTF16LE, //!< UTF-16 Little Endian Unicode encoding + wxFONTENCODING_UTF32BE, //!< UTF-32 Big Endian Unicode encoding wxFONTENCODING_UTF32LE, // UTF-32 Little Endian Unicode encoding - wxFONTENCODING_MACROMAN, // the standard mac encodings + wxFONTENCODING_MACROMAN, //!< the standard mac encodings wxFONTENCODING_MACJAPANESE, wxFONTENCODING_MACCHINESETRAD, wxFONTENCODING_MACKOREAN, @@ -196,37 +196,28 @@ enum wxFontEncoding // more CJK encodings (for historical reasons some are already declared // above) - wxFONTENCODING_ISO2022_JP, // ISO-2022-JP JIS encoding + wxFONTENCODING_ISO2022_JP, //!< ISO-2022-JP JIS encoding - wxFONTENCODING_MAX, // highest enumerated encoding value + wxFONTENCODING_MAX, //!< highest enumerated encoding value wxFONTENCODING_MACMIN = wxFONTENCODING_MACROMAN , wxFONTENCODING_MACMAX = wxFONTENCODING_MACKEYBOARD , // aliases for endian-dependent UTF encodings -#ifdef WORDS_BIGENDIAN - wxFONTENCODING_UTF16 = wxFONTENCODING_UTF16BE, // native UTF-16 - wxFONTENCODING_UTF32 = wxFONTENCODING_UTF32BE, // native UTF-32 -#else // WORDS_BIGENDIAN - wxFONTENCODING_UTF16 = wxFONTENCODING_UTF16LE, // native UTF-16 - wxFONTENCODING_UTF32 = wxFONTENCODING_UTF32LE, // native UTF-32 -#endif // WORDS_BIGENDIAN - - // alias for the native Unicode encoding on this platform - // (this is used by wxEncodingConverter and wxUTFFile only for now) -#if SIZEOF_WCHAR_T == 2 - wxFONTENCODING_UNICODE = wxFONTENCODING_UTF16, -#else // SIZEOF_WCHAR_T == 4 - wxFONTENCODING_UNICODE = wxFONTENCODING_UTF32, -#endif + wxFONTENCODING_UTF16, //!< native UTF-16 + wxFONTENCODING_UTF32, //!< native UTF-32 + + /// Alias for the native Unicode encoding on this platform + /// (this is used by wxEncodingConverter and wxUTFFile only for now) + wxFONTENCODING_UNICODE, // alternative names for Far Eastern encodings // Chinese - wxFONTENCODING_GB2312 = wxFONTENCODING_CP936, // Simplified Chinese - wxFONTENCODING_BIG5 = wxFONTENCODING_CP950, // Traditional Chinese + wxFONTENCODING_GB2312 = wxFONTENCODING_CP936, //!< Simplified Chinese + wxFONTENCODING_BIG5 = wxFONTENCODING_CP950, //!< Traditional Chinese // Japanese (see http://zsigri.tripod.com/fontboard/cjk/jis.html) - wxFONTENCODING_SHIFT_JIS = wxFONTENCODING_CP932 // Shift JIS + wxFONTENCODING_SHIFT_JIS = wxFONTENCODING_CP932 //!< Shift JIS }; diff --git a/interface/wx/intl.h b/interface/wx/intl.h index c655db5e04..06ef0aa23c 100644 --- a/interface/wx/intl.h +++ b/interface/wx/intl.h @@ -275,28 +275,38 @@ enum wxLayoutDirection }; /** - wxLanguageInfo: encapsulates ::wxLanguage to OS native lang.desc. + Encapsulates ::wxLanguage in a OS native lang.desc. translation information */ struct WXDLLIMPEXP_BASE wxLanguageInfo { - /// ::wxLanguage id. It should be greater than wxLANGUAGE_USER_DEFINED. + /// ::wxLanguage id. It should be greater than @c wxLANGUAGE_USER_DEFINED. int Language; - wxString CanonicalName; //!< Canonical name, e.g. fr_FR. -#ifdef __WXMSW__ - wxUint32 WinLang, //!< Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx). - WinSublang; -#endif // __WXMSW__ - wxString Description; //!< Human-readable name of the language. + + /// Canonical name of the language, e.g. @c fr_FR. + wxString CanonicalName; + + //@{ + /** + Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx). + + @onlyfor{wxmsw} + */ + wxUint32 WinLang, WinSublang; + //@} + + /// Human-readable name of the language. + wxString Description; + + /// The layout direction used for this language. wxLayoutDirection LayoutDirection; -#ifdef __WXMSW__ /// Return the LCID corresponding to this language. + /// @onlyfor{wxmsw} wxUint32 GetLCID() const; -#endif // __WXMSW__ /// Return the locale name corresponding to this language usable with - /// setlocale() on the current system + /// @c setlocale() on the current system. wxString GetLocaleName() const; }; diff --git a/interface/wx/sckipc.h b/interface/wx/sckipc.h index 3eaac132a8..449bf7a053 100644 --- a/interface/wx/sckipc.h +++ b/interface/wx/sckipc.h @@ -31,13 +31,7 @@ enum wxIPCFormat wxIPC_LOCALE = 16, wxIPC_UTF8TEXT = 17, wxIPC_UTF32TEXT = 18, -#if SIZEOF_WCHAR_T == 2 - wxIPC_UNICODETEXT = wxIPC_UTF16TEXT, -#elif SIZEOF_WCHAR_T == 4 - wxIPC_UNICODETEXT = wxIPC_UTF32TEXT, -#else -# error "Unknown wchar_t size" -#endif + wxIPC_UNICODETEXT, wxIPC_PRIVATE = 20 }; -- 2.45.2