hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Use self-closing tags for return and argument

Browse source 
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
This commit is contained in:
Rémi Verschelde 2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
No known key found for this signature in database
GPG key ID: C3336907360768E1
408 changed files with 14025 additions and 28050 deletions
Download patch file Download diff file Expand all files Collapse all files

63
doc/classes/TranslationServer.xml
View file

@ -12,94 +12,73 @@
</tutorials>
<methods>
<method name="add_translation">
<return type="void">
</return>
<argument index="0" name="translation" type="Translation">
</argument>
<return type="void" />
<argument index="0" name="translation" type="Translation" />
<description>
Adds a [Translation] resource.
</description>
</method>
<method name="clear">
<return type="void">
</return>
<return type="void" />
<description>
Clears the server from all translations.
</description>
</method>
<method name="get_loaded_locales" qualifiers="const">
<return type="Array">
</return>
<return type="Array" />
<description>
Returns an Array of all loaded locales of the game.
</description>
</method>
<method name="get_locale" qualifiers="const">
<return type="String">
</return>
<return type="String" />
<description>
Returns the current locale of the game.
</description>
</method>
<method name="get_locale_name" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="locale" type="String">
</argument>
<return type="String" />
<argument index="0" name="locale" type="String" />
<description>
Returns a locale's language and its variant (e.g. [code]"en_US"[/code] would return [code]"English (United States)"[/code]).
</description>
</method>
<method name="get_translation_object">
<return type="Translation">
</return>
<argument index="0" name="locale" type="String">
</argument>
<return type="Translation" />
<argument index="0" name="locale" type="String" />
<description>
Returns the [Translation] instance based on the [code]locale[/code] passed in.
It will return a [code]nullptr[/code] if there is no [Translation] instance that matches the [code]locale[/code].
</description>
</method>
<method name="remove_translation">
<return type="void">
</return>
<argument index="0" name="translation" type="Translation">
</argument>
<return type="void" />
<argument index="0" name="translation" type="Translation" />
<description>
Removes the given translation from the server.
</description>
</method>
<method name="set_locale">
<return type="void">
</return>
<argument index="0" name="locale" type="String">
</argument>
<return type="void" />
<argument index="0" name="locale" type="String" />
<description>
Sets the locale of the game.
</description>
</method>
<method name="translate" qualifiers="const">
<return type="StringName">
</return>
<argument index="0" name="message" type="StringName">
</argument>
<argument index="1" name="context" type="StringName" default="&quot;&quot;">
</argument>
<return type="StringName" />
<argument index="0" name="message" type="StringName" />
<argument index="1" name="context" type="StringName" default="&quot;&quot;" />
<description>
Returns the current locale's translation for the given message (key) and context.
</description>
</method>
<method name="translate_plural" qualifiers="const">
<return type="StringName">
</return>
<argument index="0" name="message" type="StringName">
</argument>
<argument index="1" name="plural_message" type="StringName">
</argument>
<argument index="2" name="n" type="int">
</argument>
<argument index="3" name="context" type="StringName" default="&quot;&quot;">
</argument>
<return type="StringName" />
<argument index="0" name="message" type="StringName" />
<argument index="1" name="plural_message" type="StringName" />
<argument index="2" name="n" type="int" />
<argument 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.