7adf4cc9b5
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.
35 lines
1.3 KiB
XML
35 lines
1.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="EditorSyntaxHighlighter" inherits="SyntaxHighlighter" version="4.0">
|
|
<brief_description>
|
|
Base Syntax highlighter resource for the [ScriptEditor].
|
|
</brief_description>
|
|
<description>
|
|
Base syntax highlighter resource all editor syntax highlighters extend from, it is used in the [ScriptEditor].
|
|
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">
|
|
<return type="String" />
|
|
<description>
|
|
Virtual method which can be overridden to return the syntax highlighter name.
|
|
</description>
|
|
</method>
|
|
<method name="_get_supported_extentions" qualifiers="virtual">
|
|
<return type="Array" />
|
|
<description>
|
|
Virtual method which can be overridden to return the supported file extensions.
|
|
</description>
|
|
</method>
|
|
<method name="_get_supported_languages" qualifiers="virtual">
|
|
<return type="Array" />
|
|
<description>
|
|
Virtual method which can be overridden to return the supported language names.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|