virtualx-engine/doc/classes/OptimizedTranslation.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="OptimizedTranslation" inherits="Translation" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Optimized translation.
	</brief_description>
	<description>
		Optimized translation. Uses real-time compressed translations, which results in very small dictionaries.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="generate">
			<return type="void" />
			<argument index="0" name="from" type="Translation" />
			<description>
				Generates and sets an optimized translation from the given [Translation] resource.
			</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" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 14:18:53 +01:00			`<class name="OptimizedTranslation" inherits="Translation" version="4.0" 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>`
			`Optimized translation.`
			`</brief_description>`
			`<description>`
			`Optimized translation. Uses real-time compressed translations, which results in very small dictionaries.`
			`</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" />`
			`<argument 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.`
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>`