godot/doc/classes/AudioEffect.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffect" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Audio effect for audio.
	</brief_description>
	<description>
		Base resource for audio bus. Applies an audio effect on the bus that the resource is applied on.
	</description>
	<tutorials>
		<link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</link>
	</tutorials>
	<methods>
		<method name="_instantiate" qualifiers="virtual">
			<return type="AudioEffectInstance" />
			<description>
			</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-13 04:42:36 +08: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 21:18:53 +08:00			`<class name="AudioEffect" inherits="Resource" 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-13 04:42:36 +08:00			`<brief_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			`Audio effect for audio.`
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>`
			`<description>`
			`Base resource for audio bus. Applies an audio effect on the bus that the resource is applied on.`
			`</description>`
			`<tutorials>`
Link to demos from within the class reference 2020-10-01 16:34:47 +08:00			`<link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</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>`
Discern between virtual and abstract class bindings * Previous "virtual" classes (which can't be instantiated) are not corretly named "abstract". * Added a new "virtual" category for classes, they can't be instantiated from the editor, but can be inherited from script and extensions. * Converted a large amount of classes from "abstract" to "virtual" where it makes sense. Most classes that make sense have been converted. Missing: * Physics servers * VideoStream * Script* classes. which will go in a separate PR due to the complexity involved. 2022-03-10 15:17:38 +08:00			`<methods>`
			`<method name="_instantiate" qualifiers="virtual">`
			`<return type="AudioEffectInstance" />`
			`<description>`
			`</description>`
			`</method>`
			`</methods>`
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			`</class>`