mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-15 10:12:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
2ad9f7ca61
godot/doc/classes/Translation.xml

103 lines
3.6 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 09:03:48 +08:00
<class name="Translation" inherits="Resource" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<brief_description>
Language Translation.
</brief_description>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
Translations are resources that can be loaded and unloaded on demand. They map a string to another string.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
<tutorials>
Add link titles for all links in the class reference This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-08-05 20:43:40 +08:00
<link title="Internationalizing games">https://docs.godotengine.org/en/latest/tutorials/i18n/internationalizing_games.html</link>
<link title="Locales">https://docs.godotengine.org/en/latest/tutorials/i18n/locales.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</tutorials>
<methods>
<method name="add_message">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 21:59:09 +08:00
<argument index="0" name="src_message" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</argument>
doc: Sync classref with StringName/Callable changes
2020-02-22 21:59:09 +08:00
<argument index="1" name="xlated_message" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</argument>
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 19:17:12 +08:00
<argument index="2" name="context" type="StringName" default="&quot;&quot;">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Fill info for translation related docs
2018-11-19 12:20:05 +08:00
Adds a message if nonexistent, followed by its translation.
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 19:17:12 +08:00
An additional context could be used to specify the translation context or differentiate polysemic words.
</description>
</method>
<method name="add_plural_message">
<return type="void">
</return>
<argument index="0" name="src_message" type="StringName">
</argument>
<argument index="1" name="xlated_messages" type="PackedStringArray">
</argument>
<argument index="2" name="context" type="StringName" default="&quot;&quot;">
</argument>
<description>
Adds a message involving plural translation if nonexistent, followed by its translation.
An additional context could be used to specify the translation context or differentiate polysemic words.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="erase_message">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 21:59:09 +08:00
<argument index="0" name="src_message" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</argument>
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 19:17:12 +08:00
<argument index="1" name="context" type="StringName" default="&quot;&quot;">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Fill info for translation related docs
2018-11-19 12:20:05 +08:00
Erases a message.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_message" qualifiers="const">
doc: Sync classref with StringName/Callable changes
2020-02-22 21:59:09 +08:00
<return type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 21:59:09 +08:00
<argument index="0" name="src_message" type="StringName">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</argument>
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 19:17:12 +08:00
<argument index="1" name="context" type="StringName" default="&quot;&quot;">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Fill info for translation related docs
2018-11-19 12:20:05 +08:00
Returns a message's translation.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_message_count" qualifiers="const">
<return type="int">
</return>
<description>
Fill info for translation related docs
2018-11-19 12:20:05 +08:00
Returns the number of existing messages.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_message_list" qualifiers="const">
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 20:59:24 +08:00
<return type="PackedStringArray">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</return>
<description>
Fill info for translation related docs
2018-11-19 12:20:05 +08:00
Returns all the messages (keys).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 19:17:12 +08:00
<method name="get_plural_message" qualifiers="const">
<return type="StringName">
</return>
<argument index="0" name="src_message" type="StringName">
</argument>
<argument index="1" name="src_plural_message" type="StringName">
</argument>
<argument index="2" name="n" type="int">
</argument>
<argument index="3" name="context" type="StringName" default="&quot;&quot;">
</argument>
<description>
Returns a message's translation involving plurals.
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.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="locale" type="String" setter="set_locale" getter="get_locale" default="&quot;en&quot;">
Fill info for translation related docs
2018-11-19 12:20:05 +08:00
The locale of the translation.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
</members>
<constants>
</constants>
</class>
Reference in New Issue Copy Permalink