Fix html documentation warnings.

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

diff --git a/interface/wx/intl.h b/interface/wx/intl.h
index 85264edfdff441ddf0d6ff00ef044f06cea7dc32..1f167084376ecff1023ea07dc24a1316439c09cc 100644 (file)
--- a/interface/wx/intl.h
+++ b/interface/wx/intl.h
@@ -2,7 +2,6 @@
 // Name:        intl.h
 // Purpose:     interface of wxLocale
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
@@ -391,10 +390,17 @@ public:
     static wxString GetSystemEncodingName();
 
     /**
-        Tries to detect the user's default language setting.
+        Tries to detect the user's default locale setting.
 
         Returns the ::wxLanguage value or @c wxLANGUAGE_UNKNOWN if the language-guessing
         algorithm failed.
+
+        @note This function works with @em locales and returns the user's default
+              locale. This may be, and usually is, the same as their preferred UI
+              language, but it's not the same thing. Use wxTranslation to obtain
+              @em language information.
+
+        @see wxTranslations::GetBestTranslation().
     */
     static int GetSystemLanguage();