Overhaul the top sections of the class reference (GUI classes)

This commit is contained in:
VolTer
2023-04-30 16:26:09 +02:00
parent a67d37f7cf
commit 151a4ba6a5
111 changed files with 299 additions and 320 deletions

View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="TranslationServer" inherits="Object" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Server that manages all translations.
The server responsible for language translations.
</brief_description>
<description>
Server that manages all translations. Translations can be set to it and removed from it.
The server that manages all language translations. Translations can be added to or removed from it.
</description>
<tutorials>
<link title="Internationalizing games">$DOCS_URL/tutorials/i18n/internationalizing_games.html</link>
@ -29,13 +29,13 @@
<param index="0" name="locale_a" type="String" />
<param index="1" name="locale_b" type="String" />
<description>
Compares two locales and return similarity score between [code]0[/code](no match) and [code]10[/code](full match).
Compares two locales and returns a similarity score between [code]0[/code] (no match) and [code]10[/code] (full match).
</description>
</method>
<method name="get_all_countries" qualifiers="const">
<return type="PackedStringArray" />
<description>
Returns array of known country codes.
Returns an array of known country codes.
</description>
</method>
<method name="get_all_languages" qualifiers="const">
@ -47,21 +47,21 @@
<method name="get_all_scripts" qualifiers="const">
<return type="PackedStringArray" />
<description>
Returns array of known script codes.
Returns an array of known script codes.
</description>
</method>
<method name="get_country_name" qualifiers="const">
<return type="String" />
<param index="0" name="country" type="String" />
<description>
Returns readable country name for the [param country] code.
Returns a readable country name for the [param country] code.
</description>
</method>
<method name="get_language_name" qualifiers="const">
<return type="String" />
<param index="0" name="language" type="String" />
<description>
Returns readable language name for the [param language] code.
Returns a readable language name for the [param language] code.
</description>
</method>
<method name="get_loaded_locales" qualifiers="const">
@ -88,7 +88,7 @@
<return type="String" />
<param index="0" name="script" type="String" />
<description>
Returns readable script name for the [param script] code.
Returns a readable script name for the [param script] code.
</description>
</method>
<method name="get_tool_locale">
@ -138,7 +138,7 @@
<return type="String" />
<param index="0" name="locale" type="String" />
<description>
Returns [param locale] string standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]).
Returns a [param locale] string standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]).
</description>
</method>
<method name="translate" qualifiers="const">