fix few doxygen warnings

[wxWidgets.git] / interface / wx / intl.h

diff --git a/interface/wx/intl.h b/interface/wx/intl.h
index f812132793ee71c5d6ccc70d3cb154910768c193..0f537d4dc0ff19cc4380d290b493b87d4a068efb 100644 (file)
--- a/interface/wx/intl.h
+++ b/interface/wx/intl.h
@@ -17,7 +17,7 @@
 */
 enum wxLanguage
 {
 */
 enum wxLanguage
 {

-    /// User's default/preffered language as got from OS.
+    /// User's default/preferred language as got from OS.

     wxLANGUAGE_DEFAULT,
 
     /// Unknown language, returned if wxLocale::GetSystemLanguage fails.
     wxLANGUAGE_DEFAULT,
 
     /// Unknown language, returned if wxLocale::GetSystemLanguage fails.


@@ -263,12 +263,23 @@ enum wxLanguage
 
 
 /**
 
 
 /**

-    wxLanguageInfo: encapsulates wxLanguage to OS native lang.desc.
+    This is the layout direction stored in wxLanguageInfo and returned by
+    wxApp::GetLayoutDirection() for RTL (right-to-left) languages support.
+*/
+enum wxLayoutDirection
+{
+    wxLayout_Default,
+    wxLayout_LeftToRight,
+    wxLayout_RightToLeft
+};
+
+/**
+    wxLanguageInfo: encapsulates ::wxLanguage to OS native lang.desc.

                     translation information
 */
 struct WXDLLIMPEXP_BASE wxLanguageInfo
 {
                     translation information
 */
 struct WXDLLIMPEXP_BASE wxLanguageInfo
 {

-    /// wxLanguage id. It should be greater than wxLANGUAGE_USER_DEFINED.
+    /// ::wxLanguage id. It should be greater than wxLANGUAGE_USER_DEFINED.

     int Language;
     wxString CanonicalName;         //!< Canonical name, e.g. fr_FR.
 #ifdef __WXMSW__
     int Language;
     wxString CanonicalName;         //!< Canonical name, e.g. fr_FR.
 #ifdef __WXMSW__


@@ -461,7 +472,7 @@ public:
 
         @see GetLanguageInfo()
     */
 
         @see GetLanguageInfo()
     */

-    static wxLanguageInfo* FindLanguageInfo(const wxString& locale);
+    static const wxLanguageInfo* FindLanguageInfo(const wxString& locale);

 
     /**
         Returns the canonical form of current locale name. Canonical form is the
 
     /**
         Returns the canonical form of current locale name. Canonical form is the


@@ -485,10 +496,10 @@ public:
                             const wxString& domain = wxEmptyString) const;
 
     /**
                             const wxString& domain = wxEmptyString) const;
 
     /**

-        Returns wxLanguage() constant of current language.
+        Returns the ::wxLanguage constant of current language.

 
         Note that you can call this function only if you used the form of
 
         Note that you can call this function only if you used the form of

-        Init() that takes wxLanguage argument.
+        Init() that takes ::wxLanguage argument.

     */
     int GetLanguage() const;
 
     */
     int GetLanguage() const;
 


@@ -502,7 +513,7 @@ public:
         as an argument to this function and in this case the result of
         GetSystemLanguage() is used.
     */
         as an argument to this function and in this case the result of
         GetSystemLanguage() is used.
     */

-    static wxLanguageInfo* GetLanguageInfo(int lang) const;
+    static const wxLanguageInfo* GetLanguageInfo(int lang);

 
     /**
         Returns English name of the given language or empty string if this
 
     /**
         Returns English name of the given language or empty string if this


@@ -510,7 +521,7 @@ public:
 
         See GetLanguageInfo() for a remark about special meaning of @c wxLANGUAGE_DEFAULT.
     */
 
         See GetLanguageInfo() for a remark about special meaning of @c wxLANGUAGE_DEFAULT.
     */

-    static wxString GetLanguageName(int lang) const;
+    static wxString GetLanguageName(int lang);

 
     /**
         Returns the locale name as passed to the constructor or Init().
 
     /**
         Returns the locale name as passed to the constructor or Init().


@@ -581,7 +592,7 @@ public:
         Returns wxFontEncoding() value or @c wxFONTENCODING_SYSTEM if it
         couldn't be determined.
     */
         Returns wxFontEncoding() value or @c wxFONTENCODING_SYSTEM if it
         couldn't be determined.
     */

-    static wxFontEncoding GetSystemEncoding() const;
+    static wxFontEncoding GetSystemEncoding();

 
     /**
         Tries to detect the name of the user's default font encoding.
 
     /**
         Tries to detect the name of the user's default font encoding.


@@ -591,14 +602,14 @@ public:
         Returns a user-readable string value or an empty string if it couldn't be
         determined.
     */
         Returns a user-readable string value or an empty string if it couldn't be
         determined.
     */

-    static wxString GetSystemEncodingName() const;
+    static wxString GetSystemEncodingName();

 
     /**
         Tries to detect the user's default language setting.
 
     /**
         Tries to detect the user's default language setting.

-        Returns wxLanguage value or @b wxLANGUAGE_UNKNOWN if the language-guessing
+        Returns the ::wxLanguage value or @b wxLANGUAGE_UNKNOWN if the language-guessing

         algorithm failed.
     */
         algorithm failed.
     */

-    static int GetSystemLanguage() const;
+    static int GetSystemLanguage();

 
     /**
         Initializes the wxLocale instance.
 
     /**
         Initializes the wxLocale instance.


@@ -612,7 +623,7 @@ public:
         try to translate the messages using the message catalogs for this locale.
 
         @param language
         try to translate the messages using the message catalogs for this locale.
 
         @param language

-            wxLanguage identifier of the locale.
+            ::wxLanguage identifier of the locale.

             @c wxLANGUAGE_DEFAULT has special meaning -- wxLocale will use system's
             default language (see GetSystemLanguage()).
         @param flags
             @c wxLANGUAGE_DEFAULT has special meaning -- wxLocale will use system's
             default language (see GetSystemLanguage()).
         @param flags


@@ -664,11 +675,11 @@ public:
         this locale. For example in Windows 2000 and Windows XP, support for many
         locales is not installed by default. Returns @true if the locale is
         supported.
         this locale. For example in Windows 2000 and Windows XP, support for many
         locales is not installed by default. Returns @true if the locale is
         supported.

-        The argument @a lang is the wxLanguage identifier. To obtain this for a
-        given a two letter ISO language code, use
-        FindLanguageInfo() to obtain its
-        wxLanguageInfo structure. See AddLanguage() for
-        the wxLanguageInfo description.
+
+        The argument @a lang is the ::wxLanguage identifier. To obtain this for a
+        given a two letter ISO language code, use FindLanguageInfo() to obtain its
+        wxLanguageInfo structure.
+        See AddLanguage() for the wxLanguageInfo description.

 
         @since 2.7.1.
     */
 
         @since 2.7.1.
     */


@@ -697,7 +708,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_string */
+/** @addtogroup group_funcmacro_string */

 //@{
 
 /**
 //@{
 
 /**