virtualx-engine/doc/classes/EditorSyntaxHighlighter.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSyntaxHighlighter" inherits="SyntaxHighlighter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Base class for [SyntaxHighlighter] used by the [ScriptEditor].
	</brief_description>
	<description>
		Base class that all [SyntaxHighlighter]s used by the [ScriptEditor] extend from.
		Add a syntax highlighter to an individual script by calling [method ScriptEditorBase.add_syntax_highlighter]. To apply to all scripts on open, call [method ScriptEditor.register_syntax_highlighter].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="_get_name" qualifiers="virtual const">
			<return type="String" />
			<description>
				Virtual method which can be overridden to return the syntax highlighter name.
			</description>
		</method>
		<method name="_get_supported_languages" qualifiers="virtual const">
			<return type="PackedStringArray" />
			<description>
				Virtual method which can be overridden to return the supported language names.
			</description>
		</method>
	</methods>
</class>
doc: Sync classref with current source 2020-07-15 08:43:21 +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="EditorSyntaxHighlighter" inherits="SyntaxHighlighter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with current source 2020-07-15 08:43:21 +02:00			`<brief_description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`Base class for [SyntaxHighlighter] used by the [ScriptEditor].`
doc: Sync classref with current source 2020-07-15 08:43:21 +02:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`Base class that all [SyntaxHighlighter]s used by the [ScriptEditor] extend from.`
Fix various typos in classref 2023-08-22 10:13:42 +02:00			`Add a syntax highlighter to an individual script by calling [method ScriptEditorBase.add_syntax_highlighter]. To apply to all scripts on open, call [method ScriptEditor.register_syntax_highlighter].`
doc: Sync classref with current source 2020-07-15 08:43:21 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
Replace BIND_VMETHOD by new GDVIRTUAL syntax * New syntax is type safe. * New syntax allows for type safe virtuals in native extensions. * New syntax permits extremely fast calling. Note: Everything was replaced where possible except for `_gui_input` `_input` and `_unhandled_input`. These will require API rework on a separate PR as they work different than the rest of the functions. Added a new method flag METHOD_FLAG_OBJECT_CORE, used internally. Allows to not dump the core virtuals like `_notification` to the json API, since each language will implement those as it is best fits. 2021-08-22 03:52:44 +02:00			`<method name="_get_name" qualifiers="virtual const">`
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="String" />`
doc: Sync classref with current source 2020-07-15 08:43:21 +02:00			`<description>`
Update SyntaxHighlighter documentation 2020-10-11 18:07:33 +02:00			`Virtual method which can be overridden to return the syntax highlighter name.`
doc: Sync classref with current source 2020-07-15 08:43:21 +02:00			`</description>`
			`</method>`
Replace BIND_VMETHOD by new GDVIRTUAL syntax * New syntax is type safe. * New syntax allows for type safe virtuals in native extensions. * New syntax permits extremely fast calling. Note: Everything was replaced where possible except for `_gui_input` `_input` and `_unhandled_input`. These will require API rework on a separate PR as they work different than the rest of the functions. Added a new method flag METHOD_FLAG_OBJECT_CORE, used internally. Allows to not dump the core virtuals like `_notification` to the json API, since each language will implement those as it is best fits. 2021-08-22 03:52:44 +02:00			`<method name="_get_supported_languages" qualifiers="virtual const">`
Replace Array return types with TypedArray 2022-08-05 03:41:48 +02:00			`<return type="PackedStringArray" />`
doc: Sync classref with current source 2020-07-15 08:43:21 +02:00			`<description>`
Update SyntaxHighlighter documentation 2020-10-11 18:07:33 +02:00			`Virtual method which can be overridden to return the supported language names.`
doc: Sync classref with current source 2020-07-15 08:43:21 +02:00			`</description>`
			`</method>`
			`</methods>`
			`</class>`