noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

[doc] Use "param" instead of "code" to refer to parameters

Browse Source
This commit is contained in:
Andy Maloney
2022-08-09 11:19:47 -04:00
committed by Yuri Sizov
parent e9e9e92e48
commit 2d54c36c3c
27 changed files with 373 additions and 373 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/TranslationServer.xml
+9 -9
View File
@@ -54,14 +54,14 @@
<return type="String" />
<param index="0" name="country" type="String" />
<description>
Returns readable country name for the [code]country[/code] code.
Returns 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 [code]language[/code] code.
Returns 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 [code]script[/code] code.
Returns readable script name for the [param script] code.
</description>
</method>
<method name="get_tool_locale">
@@ -102,15 +102,15 @@
<return type="Translation" />
<param index="0" name="locale" type="String" />
<description>
Returns the [Translation] instance based on the [code]locale[/code] passed in.
It will return [code]null[/code] if there is no [Translation] instance that matches the [code]locale[/code].
Returns the [Translation] instance based on the [param locale] passed in.
It will return [code]null[/code] if there is no [Translation] instance that matches the [param locale].
</description>
</method>
<method name="pseudolocalize" qualifiers="const">
<return type="StringName" />
<param index="0" name="message" type="StringName" />
<description>
Returns the pseudolocalized string based on the [code]p_message[/code] passed in.
Returns the pseudolocalized string based on the [param message] passed in.
</description>
</method>
<method name="reload_pseudolocalization">
@@ -130,7 +130,7 @@
<return type="void" />
<param index="0" name="locale" type="String" />
<description>
Sets the locale of the project. The [code]locale[/code] string will be standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]).
Sets the locale of the project. The [param locale] string will be standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]).
If translations have been loaded beforehand for the new locale, they will be applied.
</description>
</method>
@@ -138,7 +138,7 @@
<return type="String" />
<param index="0" name="locale" type="String" />
<description>
Returns [code]locale[/code] string standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]).
Returns [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">
@@ -157,7 +157,7 @@
<param index="3" name="context" type="StringName" default="&quot;&quot;" />
<description>
Returns the current locale's translation for the given message (key), plural_message and context.
The number [code]n[/code] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language.
The number [param n] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language.
</description>
</method>
</methods>