virtualx-engine/doc/classes/OptimizedTranslation.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="OptimizedTranslation" inherits="Translation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		An optimized translation, used by default for CSV Translations.
	</brief_description>
	<description>
		An optimized translation, used by default for CSV Translations. Uses real-time compressed translations, which results in very small dictionaries.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="generate">
			<return type="void" />
			<param index="0" name="from" type="Translation" />
			<description>
				Generates and sets an optimized translation from the given [Translation] resource.
				[b]Note:[/b] This method is intended to be used in the editor. It does nothing when called from an exported project.
			</description>
		</method>
	</methods>
</class>
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-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="OptimizedTranslation" inherits="Translation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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-12 22:42:36 +02:00			`<brief_description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`An optimized translation, used by default for CSV Translations.`
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-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`An optimized translation, used by default for CSV Translations. Uses real-time compressed translations, which results in very small dictionaries.`
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-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`<method name="generate">`
doc: Use self-closing tags for `return` and `argument` 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. 2021-07-30 15:28:05 +02:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="from" type="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-12 22:42:36 +02:00			`<description>`
Fill info for translation related docs 2018-11-19 05:20:05 +01:00			`Generates and sets an optimized translation from the given [Translation] resource.`
Document `OptimizedTranslation.generate()` only works in editor 2024-09-21 17:17:38 +02:00			`[b]Note:[/b] This method is intended to be used in the editor. It does nothing when called from an exported project.`
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-12 22:42:36 +02:00			`</description>`
			`</method>`
			`</methods>`
			`</class>`