Merge pull request #23834 from YeldhamDev/doc_translation_classes

Fill info for translation related docs

3 files changed, 20 insertions, 5 deletions

diff --git a/doc/classes/PHashTranslation.xml b/doc/classes/PHashTranslation.xml
index 18c72a0576..e5745375b0 100644
--- a/doc/classes/PHashTranslation.xml
+++ b/doc/classes/PHashTranslation.xml
@@ -17,6 +17,7 @@
 			<argument index="0" name="from" type="Translation">
 			</argument>
 			<description>
+				Generates and sets an optimized translation from the given [Translation] resource.
 			</description>
 		</method>
 	</methods>
diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml
index c4e9dbfb70..b57f8f3556 100644
--- a/doc/classes/Translation.xml
+++ b/doc/classes/Translation.xml
@@ -7,6 +7,8 @@
 		Translations are resources that can be loaded/unloaded on demand. They map a string to another string.
 	</description>
 	<tutorials>
+		<link>https://docs.godotengine.org/en/stable/tutorials/i18n/internationalizing_games.html</link>
+		<link>https://docs.godotengine.org/en/stable/tutorials/i18n/locales.html</link>
 	</tutorials>
 	<demos>
 	</demos>
@@ -19,7 +21,7 @@
 			<argument index="1" name="xlated_message" type="String">
 			</argument>
 			<description>
-				Add a message for translation.
+				Adds a message if nonexistent, followed by its translation.
 			</description>
 		</method>
 		<method name="erase_message">
@@ -28,7 +30,7 @@
 			<argument index="0" name="src_message" type="String">
 			</argument>
 			<description>
-				Erase a message.
+				Erases a message.
 			</description>
 		</method>
 		<method name="get_message" qualifiers="const">
@@ -37,25 +39,27 @@
 			<argument index="0" name="src_message" type="String">
 			</argument>
 			<description>
-				Return a message for translation.
+				Returns a message's translation.
 			</description>
 		</method>
 		<method name="get_message_count" qualifiers="const">
 			<return type="int">
 			</return>
 			<description>
+				Returns the number of existing messages.
 			</description>
 		</method>
 		<method name="get_message_list" qualifiers="const">
 			<return type="PoolStringArray">
 			</return>
 			<description>
-				Return all the messages (keys).
+				Returns all the messages (keys).
 			</description>
 		</method>
 	</methods>
 	<members>
 		<member name="locale" type="String" setter="set_locale" getter="get_locale">
+			The locale of the translation.
 		</member>
 	</members>
 	<constants>
diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml
index 52d2b2cc47..c2c400ccd5 100644
--- a/doc/classes/TranslationServer.xml
+++ b/doc/classes/TranslationServer.xml
@@ -1,11 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="TranslationServer" inherits="Object" category="Core" version="3.1">
 	<brief_description>
-		Server that manages all translations. Translations can be set to it and removed from it.
+		Server that manages all translations.
 	</brief_description>
 	<description>
+		Server that manages all translations. Translations can be set to it and removed from it.
 	</description>
 	<tutorials>
+		<link>https://docs.godotengine.org/en/stable/tutorials/i18n/internationalizing_games.html</link>
+		<link>https://docs.godotengine.org/en/stable/tutorials/i18n/locales.html</link>
 	</tutorials>
 	<demos>
 	</demos>
@@ -16,18 +19,21 @@
 			<argument index="0" name="translation" type="Translation">
 			</argument>
 			<description>
+				Adds a [Translation] resource.
 			</description>
 		</method>
 		<method name="clear">
 			<return type="void">
 			</return>
 			<description>
+				Clears the server from all translations.
 			</description>
 		</method>
 		<method name="get_locale" qualifiers="const">
 			<return type="String">
 			</return>
 			<description>
+				Returns the current locale of the game.
 			</description>
 		</method>
 		<method name="get_locale_name" qualifiers="const">
@@ -36,6 +42,7 @@
 			<argument index="0" name="locale" type="String">
 			</argument>
 			<description>
+				Returns a locale's language and its variant (e.g. "en_US" would return "English (United States)").
 			</description>
 		</method>
 		<method name="remove_translation">
@@ -44,6 +51,7 @@
 			<argument index="0" name="translation" type="Translation">
 			</argument>
 			<description>
+				Removes the given translation from the server.
 			</description>
 		</method>
 		<method name="set_locale">
@@ -52,6 +60,7 @@
 			<argument index="0" name="locale" type="String">
 			</argument>
 			<description>
+				Sets the locale of the game.
 			</description>
 		</method>
 		<method name="translate" qualifiers="const">
@@ -60,6 +69,7 @@
 			<argument index="0" name="message" type="String">
 			</argument>
 			<description>
+				Returns the current locale's translation for the given message (key).
 			</description>
 		</method>
 	</methods>