diff options
Diffstat (limited to 'doc/classes/SyntaxHighlighter.xml')
| -rw-r--r-- | doc/classes/SyntaxHighlighter.xml | 27 |
1 files changed, 9 insertions, 18 deletions
diff --git a/doc/classes/SyntaxHighlighter.xml b/doc/classes/SyntaxHighlighter.xml index 642d75fa9b..ea0d1c27a3 100644 --- a/doc/classes/SyntaxHighlighter.xml +++ b/doc/classes/SyntaxHighlighter.xml @@ -12,42 +12,35 @@ </tutorials> <methods> <method name="_clear_highlighting_cache" qualifiers="virtual"> - <return type="void"> - </return> + <return type="void" /> <description> Virtual method which can be overridden to clear any local caches. </description> </method> <method name="_get_line_syntax_highlighting" qualifiers="virtual"> - <return type="Dictionary"> - </return> - <argument index="0" name="line" type="int"> - </argument> + <return type="Dictionary" /> + <argument index="0" name="line" type="int" /> <description> Virtual method which can be overridden to return syntax highlighting data. See [method get_line_syntax_highlighting] for more details. </description> </method> <method name="_update_cache" qualifiers="virtual"> - <return type="void"> - </return> + <return type="void" /> <description> Virtual method which can be overridden to update any local caches. </description> </method> <method name="clear_highlighting_cache"> - <return type="void"> - </return> + <return type="void" /> <description> Clears all cached syntax highlighting data. Then calls overridable method [method _clear_highlighting_cache]. </description> </method> <method name="get_line_syntax_highlighting"> - <return type="Dictionary"> - </return> - <argument index="0" name="line" type="int"> - </argument> + <return type="Dictionary" /> + <argument index="0" name="line" type="int" /> <description> Returns syntax highlighting data for a single line. If the line is not cached, calls [method _get_line_syntax_highlighting] to calculate the data. The return [Dictionary] is column number to [Dictionary]. The column number notes the start of a region, the region will end if another region is found, or at the end of the line. The nested [Dictionary] contains the data for that region, currently only the key "color" is supported. @@ -66,15 +59,13 @@ </description> </method> <method name="get_text_edit"> - <return type="TextEdit"> - </return> + <return type="TextEdit" /> <description> Returns the associated [TextEdit] node. </description> </method> <method name="update_cache"> - <return type="void"> - </return> + <return type="void" /> <description> Clears then updates the [SyntaxHighlighter] caches. Override [method _update_cache] for a callback. [b]Note:[/b] This is called automatically when the associated [TextEdit] node, updates its own cache. |