virtualx-engine/doc/classes/ImageTextureLayered.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ImageTextureLayered" inherits="TextureLayered" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
	</brief_description>
	<description>
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="create_from_images">
			<return type="int" enum="Error" />
			<param index="0" name="images" type="Image[]" />
			<description>
			</description>
		</method>
		<method name="update_layer">
			<return type="void" />
			<param index="0" name="image" type="Image" />
			<param index="1" name="layer" type="int" />
			<description>
			</description>
		</method>
	</methods>
</class>
doc: Sync classref with current source 2020-05-15 18:24:38 +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="ImageTextureLayered" inherits="TextureLayered" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with current source 2020-05-15 18:24:38 +02:00			`<brief_description>`
			`</brief_description>`
			`<description>`
			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`<method name="create_from_images">`
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="int" enum="Error" />`
Change Array arguments to TypedArray 2022-08-31 19:24:04 +02:00			`<param index="0" name="images" type="Image[]" />`
doc: Sync classref with current source 2020-05-15 18:24:38 +02:00			`<description>`
			`</description>`
			`</method>`
			`<method name="update_layer">`
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="image" type="Image" />`
			`<param index="1" name="layer" type="int" />`
doc: Sync classref with current source 2020-05-15 18:24:38 +02:00			`<description>`
			`</description>`
			`</method>`
			`</methods>`
			`</class>`