godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/EditorSyntaxHighlighter.xml

35 lines
1.3 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSyntaxHighlighter" inherits="SyntaxHighlighter" version="4.0">
<brief_description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Base Syntax highlighter resource for the [ScriptEditor].
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
</brief_description>
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Base syntax highlighter resource all editor syntax highlighters extend from, it is used in the [ScriptEditor].
Consistently prefix bound virtual methods with _
2021-05-15 21:48:59 +00: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 06:43:21 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="_get_name" qualifiers="virtual">
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 13:28:05 +00:00
<return type="String" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Virtual method which can be overridden to return the syntax highlighter name.
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
</description>
</method>
<method name="_get_supported_extentions" qualifiers="virtual">
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 13:28:05 +00:00
<return type="Array" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Virtual method which can be overridden to return the supported file extensions.
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
</description>
</method>
<method name="_get_supported_languages" qualifiers="virtual">
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 13:28:05 +00:00
<return type="Array" />
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
<description>
Update SyntaxHighlighter documentation
2020-10-11 16:07:33 +00:00
Virtual method which can be overridden to return the supported language names.
doc: Sync classref with current source
2020-07-15 06:43:21 +00:00
</description>
</method>
</methods>
<constants>
</constants>
</class>