From f248f0593c7e5a839bda94c823d0dcd6c7bbd5df Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Va=CC=81clav=20Slavi=CC=81k?= <vaclav@slavik.io>
Date: Mon, 12 Feb 2024 14:30:48 +0100
Subject: [PATCH] Clarify GetAvailableTranslations() return value

Add a note explaining that the msgid language is not included.
---
 interface/wx/translation.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/interface/wx/translation.h b/interface/wx/translation.h
index bfecf3d24f..d90a896d0e 100644
--- a/interface/wx/translation.h
+++ b/interface/wx/translation.h
@@ -85,6 +85,11 @@ public:
         translations offered to the user. To do this, pass the app's main
         catalog as @a domain.
 
+        @note
+        The returned list does not include messages ID language, i.e. the
+        language (typically English) included in the source code. In the use
+        case described above, that language needs to be added manually.
+
         @see GetBestTranslation()
      */
     wxArrayString GetAvailableTranslations(const wxString& domain) const;