]> git.saurik.com Git - wxWidgets.git/commitdiff
Document domain parameter of wxTranslations::GetTranslatedString().
authorVadim Zeitlin <vadim@wxwidgets.org>
Tue, 1 Oct 2013 13:03:15 +0000 (13:03 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Tue, 1 Oct 2013 13:03:15 +0000 (13:03 +0000)
This parameter needs to be documented, if only to avoid a Doxygen warning.

See #15346.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74892 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/translation.h

index 4e9fccc9539f897dddd116da268ddc7c3b8f961a..b26b879f925b1bb6421590992d64c33d3962eca7 100644 (file)
@@ -257,6 +257,10 @@ public:
                            (In some languages, there are different plural forms
                            for e.g. n=2 and n=3 etc., in addition to the singlular
                            form (n=1) being different.)
+        @param domain      The only domain (i.e. message catalog) to search if
+                           specified. By default this parameter is empty,
+                           indicating that all loaded catalogs should be
+                           searched.
 
         See GNU gettext manual for additional information on plural forms handling.
         This method is called by the wxGetTranslation() function and _() macro.