virtualx-engine/modules/gdscript/doc_classes/GDScript.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GDScript" inherits="Script" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		A script implemented in the GDScript programming language.
	</brief_description>
	<description>
		A script implemented in the GDScript programming language. The script extends the functionality of all objects that instantiate it.
		[method new] creates a new instance of the script. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes.
	</description>
	<tutorials>
		<link title="GDScript documentation index">$DOCS_URL/tutorials/scripting/gdscript/index.html</link>
	</tutorials>
	<methods>
		<method name="new" qualifiers="vararg">
			<return type="Variant" />
			<description>
				Returns a new instance of the script.
				For example:
				[codeblock]
				var MyClass = load("myclass.gd")
				var instance = MyClass.new()
				assert(instance.get_script() == MyClass)
				[/codeblock]
			</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="GDScript" inherits="Script" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/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>`
			`A script implemented in the GDScript programming language.`
			`</brief_description>`
			`<description>`
Fix small mistakes throughout much of the documentation 2022-10-20 04:09:17 +02:00			`A script implemented in the GDScript programming language. The script extends the functionality of all objects that instantiate it.`
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			`[method new] creates a new instance of the script. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes.`
			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 10:43:07 +01:00			`<link title="GDScript documentation index">$DOCS_URL/tutorials/scripting/gdscript/index.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-12 22:42:36 +02:00			`</tutorials>`
			`<methods>`
			`<method name="new" qualifiers="vararg">`
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="Variant" />`
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>`
			`Returns a new instance of the script.`
			`For example:`
			`[codeblock]`
			`var MyClass = load("myclass.gd")`
			`var instance = MyClass.new()`
			`assert(instance.get_script() == MyClass)`
			`[/codeblock]`
			`</description>`
			`</method>`
			`</methods>`
			`</class>`